controller.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2020 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************
 * This file is a part of RDMnet. For more information, go to:
 * https://github.com/ETCLabs/RDMnet
 *****************************************************************************/
 
#ifndef RDMNET_CONTROLLER_H_
#define RDMNET_CONTROLLER_H_
 
#include <stdbool.h>
#include "etcpal/uuid.h"
#include "etcpal/inet.h"
#include "rdm/uid.h"
#include "rdmnet/client.h"
#include "rdmnet/message.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int rdmnet_controller_t;
#define RDMNET_CONTROLLER_INVALID -1
 
typedef void (*RdmnetControllerConnectedCallback)(rdmnet_controller_t              controller_handle,
                                                  rdmnet_client_scope_t            scope_handle,
                                                  const RdmnetClientConnectedInfo* info,
                                                  void*                            context);
 
typedef void (*RdmnetControllerConnectFailedCallback)(rdmnet_controller_t                  controller_handle,
                                                      rdmnet_client_scope_t                scope_handle,
                                                      const RdmnetClientConnectFailedInfo* info,
                                                      void*                                context);
 
typedef void (*RdmnetControllerDisconnectedCallback)(rdmnet_controller_t                 controller_handle,
                                                     rdmnet_client_scope_t               scope_handle,
                                                     const RdmnetClientDisconnectedInfo* info,
                                                     void*                               context);
 
typedef void (*RdmnetControllerClientListUpdateReceivedCallback)(rdmnet_controller_t        controller_handle,
                                                                 rdmnet_client_scope_t      scope_handle,
                                                                 client_list_action_t       list_action,
                                                                 const RdmnetRptClientList* client_list,
                                                                 void*                      context);
 
typedef bool (*RdmnetControllerRdmResponseReceivedCallback)(rdmnet_controller_t      controller_handle,
                                                            rdmnet_client_scope_t    scope_handle,
                                                            const RdmnetRdmResponse* resp,
                                                            void*                    context);
 
typedef void (*RdmnetControllerStatusReceivedCallback)(rdmnet_controller_t    controller_handle,
                                                       rdmnet_client_scope_t  scope_handle,
                                                       const RdmnetRptStatus* status,
                                                       void*                  context);
 
typedef void (*RdmnetControllerResponderIdsReceivedCallback)(rdmnet_controller_t                   controller_handle,
                                                             rdmnet_client_scope_t                 scope_handle,
                                                             const RdmnetDynamicUidAssignmentList* list,
                                                             void*                                 context);
 
typedef struct RdmnetControllerCallbacks
{
  RdmnetControllerConnectedCallback                connected;                   
  RdmnetControllerConnectFailedCallback            connect_failed;              
  RdmnetControllerDisconnectedCallback             disconnected;                
  RdmnetControllerClientListUpdateReceivedCallback client_list_update_received; 
  RdmnetControllerRdmResponseReceivedCallback      rdm_response_received;       
  RdmnetControllerStatusReceivedCallback           status_received;             
  RdmnetControllerResponderIdsReceivedCallback     responder_ids_received;      
  void* context; 
} RdmnetControllerCallbacks;
 
typedef void (*RdmnetControllerRdmCommandReceivedCallback)(rdmnet_controller_t     controller_handle,
                                                           rdmnet_client_scope_t   scope_handle,
                                                           const RdmnetRdmCommand* cmd,
                                                           RdmnetSyncRdmResponse*  response,
                                                           void*                   context);
 
typedef void (*RdmnetControllerLlrpRdmCommandReceivedCallback)(rdmnet_controller_t    controller_handle,
                                                               const LlrpRdmCommand*  cmd,
                                                               RdmnetSyncRdmResponse* response,
                                                               void*                  context);
typedef struct RdmnetControllerRdmCmdHandler
{
  RdmnetControllerRdmCommandReceivedCallback rdm_command_received;
  RdmnetControllerLlrpRdmCommandReceivedCallback llrp_rdm_command_received;
  uint8_t* response_buf;
  void* context;
} RdmnetControllerRdmCmdHandler;
 
typedef struct RdmnetControllerRdmData
{
  /****************************************************************************
   * These items do not have default values from the config initializer
   ***************************************************************************/
 
  uint16_t model_id;
  uint32_t software_version_id;
  const char* manufacturer_label;
  const char* device_model_description;
  const char* software_version_label;
  const char* device_label;
 
  /****************************************************************************
   * These items have default values from the config initializer
   ***************************************************************************/
 
  uint16_t product_category;
  bool device_label_settable;
} RdmnetControllerRdmData;
 
#define RDMNET_CONTROLLER_RDM_DATA_DEFAULT_INIT                                   \
  {                                                                               \
    0, 0, NULL, NULL, NULL, NULL, E120_PRODUCT_CATEGORY_CONTROL_CONTROLLER, false \
  }
 
typedef struct RdmnetControllerConfig
{
  /************************************************************************************************
   * Required Values
   ***********************************************************************************************/
 
  EtcPalUuid cid;
  RdmnetControllerCallbacks callbacks;
  RdmnetControllerRdmCmdHandler rdm_handler;
  RdmnetControllerRdmData rdm_data;
 
  /************************************************************************************************
   * Optional Values
   ***********************************************************************************************/
 
  RdmUid uid;
 
  const char* search_domain;
 
  bool create_llrp_target;
} RdmnetControllerConfig;
 
#define RDMNET_CONTROLLER_CONFIG_DEFAULT_INIT(manu_id)                                 \
  {                                                                                    \
    {{0}}, {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL}, {NULL, NULL, NULL, NULL}, \
        RDMNET_CONTROLLER_RDM_DATA_DEFAULT_INIT, {(0x8000 | manu_id), 0}, NULL, false  \
  }
 
void rdmnet_controller_config_init(RdmnetControllerConfig* config, uint16_t manufacturer_id);
void rdmnet_controller_set_callbacks(RdmnetControllerConfig*                          config,
                                     RdmnetControllerConnectedCallback                connected,
                                     RdmnetControllerConnectFailedCallback            connect_failed,
                                     RdmnetControllerDisconnectedCallback             disconnected,
                                     RdmnetControllerClientListUpdateReceivedCallback client_list_update_received,
                                     RdmnetControllerRdmResponseReceivedCallback      rdm_response_received,
                                     RdmnetControllerStatusReceivedCallback           status_received,
                                     RdmnetControllerResponderIdsReceivedCallback     responder_ids_received,
                                     void*                                            context);
void rdmnet_controller_set_rdm_cmd_callbacks(RdmnetControllerConfig*                        config,
                                             RdmnetControllerRdmCommandReceivedCallback     rdm_command_received,
                                             RdmnetControllerLlrpRdmCommandReceivedCallback llrp_rdm_command_received,
                                             uint8_t*                                       response_buf,
                                             void*                                          context);
 
etcpal_error_t rdmnet_controller_create(const RdmnetControllerConfig* config, rdmnet_controller_t* handle);
etcpal_error_t rdmnet_controller_destroy(rdmnet_controller_t controller_handle, rdmnet_disconnect_reason_t reason);
 
etcpal_error_t rdmnet_controller_add_scope(rdmnet_controller_t      controller_handle,
                                           const RdmnetScopeConfig* scope_config,
                                           rdmnet_client_scope_t*   scope_handle);
etcpal_error_t rdmnet_controller_add_default_scope(rdmnet_controller_t    controller_handle,
                                                   rdmnet_client_scope_t* scope_handle);
etcpal_error_t rdmnet_controller_remove_scope(rdmnet_controller_t        controller_handle,
                                              rdmnet_client_scope_t      scope_handle,
                                              rdmnet_disconnect_reason_t reason);
etcpal_error_t rdmnet_controller_change_scope(rdmnet_controller_t        controller_handle,
                                              rdmnet_client_scope_t      scope_handle,
                                              const RdmnetScopeConfig*   new_scope_config,
                                              rdmnet_disconnect_reason_t disconnect_reason);
etcpal_error_t rdmnet_controller_get_scope(rdmnet_controller_t   controller_handle,
                                           rdmnet_client_scope_t scope_handle,
                                           char*                 scope_str_buf,
                                           EtcPalSockAddr*       static_broker_addr);
 
etcpal_error_t rdmnet_controller_change_search_domain(rdmnet_controller_t        controller_handle,
                                                      const char*                new_search_domain,
                                                      rdmnet_disconnect_reason_t disconnect_reason);
 
etcpal_error_t rdmnet_controller_request_client_list(rdmnet_controller_t   controller_handle,
                                                     rdmnet_client_scope_t scope_handle);
etcpal_error_t rdmnet_controller_request_responder_ids(rdmnet_controller_t   controller_handle,
                                                       rdmnet_client_scope_t scope_handle,
                                                       const RdmUid*         uids,
                                                       size_t                num_uids);
 
etcpal_error_t rdmnet_controller_send_rdm_command(rdmnet_controller_t          controller_handle,
                                                  rdmnet_client_scope_t        scope_handle,
                                                  const RdmnetDestinationAddr* destination,
                                                  rdmnet_command_class_t       command_class,
                                                  uint16_t                     param_id,
                                                  const uint8_t*               data,
                                                  uint8_t                      data_len,
                                                  uint32_t*                    seq_num);
etcpal_error_t rdmnet_controller_send_get_command(rdmnet_controller_t          controller_handle,
                                                  rdmnet_client_scope_t        scope_handle,
                                                  const RdmnetDestinationAddr* destination,
                                                  uint16_t                     param_id,
                                                  const uint8_t*               data,
                                                  uint8_t                      data_len,
                                                  uint32_t*                    seq_num);
etcpal_error_t rdmnet_controller_send_set_command(rdmnet_controller_t          controller_handle,
                                                  rdmnet_client_scope_t        scope_handle,
                                                  const RdmnetDestinationAddr* destination,
                                                  uint16_t                     param_id,
                                                  const uint8_t*               data,
                                                  uint8_t                      data_len,
                                                  uint32_t*                    seq_num);
 
etcpal_error_t rdmnet_controller_send_rdm_ack(rdmnet_controller_t          controller_handle,
                                              rdmnet_client_scope_t        scope_handle,
                                              const RdmnetSavedRdmCommand* received_cmd,
                                              const uint8_t*               response_data,
                                              size_t                       response_data_len);
etcpal_error_t rdmnet_controller_send_rdm_nack(rdmnet_controller_t          controller_handle,
                                               rdmnet_client_scope_t        scope_handle,
                                               const RdmnetSavedRdmCommand* received_cmd,
                                               rdm_nack_reason_t            nack_reason);
etcpal_error_t rdmnet_controller_send_rdm_update(rdmnet_controller_t   controller_handle,
                                                 rdmnet_client_scope_t scope_handle,
                                                 uint16_t              subdevice,
                                                 uint16_t              param_id,
                                                 const uint8_t*        data,
                                                 size_t                data_len);
 
etcpal_error_t rdmnet_controller_send_llrp_ack(rdmnet_controller_t        controller_handle,
                                               const LlrpSavedRdmCommand* received_cmd,
                                               const uint8_t*             response_data,
                                               uint8_t                    response_data_len);
etcpal_error_t rdmnet_controller_send_llrp_nack(rdmnet_controller_t        controller_handle,
                                                const LlrpSavedRdmCommand* received_cmd,
                                                rdm_nack_reason_t          nack_reason);
 
#ifdef __cplusplus
};
#endif
 
#endif /* RDMNET_CONTROLLER_H_ */