llrp_manager.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_LLRP_MANAGER_H_
#define RDMNET_LLRP_MANAGER_H_
 
#include "etcpal/uuid.h"
#include "etcpal/inet.h"
#include "rdm/message.h"
#include "rdmnet/common.h"
#include "rdmnet/llrp.h"
#include "rdmnet/message.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int llrp_manager_t;
#define LLRP_MANAGER_INVALID -1
 
typedef void (*LlrpManagerTargetDiscoveredCallback)(llrp_manager_t              handle,
                                                    const LlrpDiscoveredTarget* target,
                                                    void*                       context);
 
typedef void (*LlrpManagerRdmResponseReceivedCallback)(llrp_manager_t         handle,
                                                       const LlrpRdmResponse* resp,
                                                       void*                  context);
 
typedef void (*LlrpManagerDiscoveryFinishedCallback)(llrp_manager_t handle, void* context);
 
typedef struct LlrpManagerCallbacks
{
  LlrpManagerTargetDiscoveredCallback    target_discovered;     
  LlrpManagerRdmResponseReceivedCallback rdm_response_received; 
  LlrpManagerDiscoveryFinishedCallback   discovery_finished;    
  void* context; 
} LlrpManagerCallbacks;
 
typedef struct LlrpManagerConfig
{
  /************************************************************************************************
   * Required Values
   ***********************************************************************************************/
 
  EtcPalUuid cid;
  EtcPalMcastNetintId netint;
  uint16_t manu_id;
  LlrpManagerCallbacks callbacks;
} LlrpManagerConfig;
 
#define LLRP_MANAGER_CONFIG_DEFAULT_INIT                            \
  {                                                                 \
    {{0}}, {kEtcPalIpTypeInvalid, 0}, 0, { NULL, NULL, NULL, NULL } \
  }
 
void llrp_manager_config_init(LlrpManagerConfig* config, uint16_t manufacturer_id);
void llrp_manager_config_set_callbacks(LlrpManagerConfig*                     config,
                                       LlrpManagerTargetDiscoveredCallback    target_discovered,
                                       LlrpManagerRdmResponseReceivedCallback rdm_response_received,
                                       LlrpManagerDiscoveryFinishedCallback   discovery_finished,
                                       void*                                  context);
 
etcpal_error_t llrp_manager_create(const LlrpManagerConfig* config, llrp_manager_t* handle);
etcpal_error_t llrp_manager_destroy(llrp_manager_t handle);
 
etcpal_error_t llrp_manager_start_discovery(llrp_manager_t handle, uint16_t filter);
etcpal_error_t llrp_manager_stop_discovery(llrp_manager_t handle);
 
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);
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);
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);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RDMNET_LLRP_MANAGER_H_ */