RDMnet  0.3.0
Implementation of ANSI E1.33 (RDMnet)
View other versions:
llrp_manager.h File Reference

Overview

Functions for implementing LLRP Manager functionality.

#include "etcpal/uuid.h"
#include "etcpal/inet.h"
#include "rdm/message.h"
#include "rdmnet/common.h"
#include "rdmnet/llrp.h"
#include "rdmnet/message.h"

Go to the source code of this file.

Data Structures

struct  LlrpManagerCallbacks
 A set of notification callbacks received about an LLRP manager. More...
 
struct  LlrpManagerConfig
 A set of information that defines the startup parameters of an LLRP Manager. More...
 

Macros

#define LLRP_MANAGER_INVALID   -1
 An invalid LLRP manager handle value.
 
#define LLRP_MANAGER_CONFIG_DEFAULT_INIT
 A default-value initializer for an LlrpManagerConfig struct. More...
 

Typedefs

typedef int llrp_manager_t
 A handle for an instance of LLRP Manager functionality.
 
typedef void(* LlrpManagerTargetDiscoveredCallback) (llrp_manager_t handle, const LlrpDiscoveredTarget *target, void *context)
 An LLRP target has been discovered. More...
 
typedef void(* LlrpManagerRdmResponseReceivedCallback) (llrp_manager_t handle, const LlrpRdmResponse *resp, void *context)
 An RDM response has been received from an LLRP target. More...
 
typedef void(* LlrpManagerDiscoveryFinishedCallback) (llrp_manager_t handle, void *context)
 The previously-started LLRP discovery process has finished. More...
 
typedef struct LlrpManagerCallbacks LlrpManagerCallbacks
 A set of notification callbacks received about an LLRP manager.
 
typedef struct LlrpManagerConfig LlrpManagerConfig
 A set of information that defines the startup parameters of an LLRP Manager.
 

Functions

void llrp_manager_config_init (LlrpManagerConfig *config, uint16_t manufacturer_id)
 Initialize an LlrpManagerConfig with default values for the optional config options. More...
 
void llrp_manager_config_set_callbacks (LlrpManagerConfig *config, LlrpManagerTargetDiscoveredCallback target_discovered, LlrpManagerRdmResponseReceivedCallback rdm_response_received, LlrpManagerDiscoveryFinishedCallback discovery_finished, void *context)
 Set the callbacks in an LLRP manager configuration structure. More...
 
etcpal_error_t llrp_manager_create (const LlrpManagerConfig *config, llrp_manager_t *handle)
 Create a new LLRP manager instance. More...
 
etcpal_error_t llrp_manager_destroy (llrp_manager_t handle)
 Destroy an LLRP manager instance. More...
 
etcpal_error_t llrp_manager_start_discovery (llrp_manager_t handle, uint16_t filter)
 Start discovery on an LLRP manager. More...
 
etcpal_error_t llrp_manager_stop_discovery (llrp_manager_t handle)
 Stop discovery on an LLRP manager. More...
 
etcpal_error_t llrp_manager_send_rdm_command (llrp_manager_t handle, const LlrpDestinationAddr *destination, rdmnet_command_class_t command_class, uint16_t param_id, const uint8_t *data, uint8_t data_len, uint32_t *seq_num)
 Send an RDM command from an LLRP manager. More...
 
etcpal_error_t llrp_manager_send_get_command (llrp_manager_t handle, const LlrpDestinationAddr *destination, uint16_t param_id, const uint8_t *data, uint8_t data_len, uint32_t *seq_num)
 Send an RDM GET command from an LLRP manager. More...
 
etcpal_error_t llrp_manager_send_set_command (llrp_manager_t handle, const LlrpDestinationAddr *destination, uint16_t param_id, const uint8_t *data, uint8_t data_len, uint32_t *seq_num)
 Send an RDM SET command from an LLRP manager. More...