dsm-api-v2
|
This group of API calls addresses single devices and their properties. More...
Typedefs | |
typedef void(* | CircuitRemoveDevice_by_dsid_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t SerialNumber) |
Removes the device selected by dSID from the data model. | |
typedef void(* | CircuitRemoveDevice_by_dsid_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes the device selected by dSID from the data model. | |
typedef void(* | CircuitRemoveDevice_by_id_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Removes the device selected by DeviceId from the data model. | |
typedef void(* | CircuitRemoveDevice_by_id_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes the device selected by DeviceId from the data model. | |
typedef void(* | CircuitRemoveDevice_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) __attribute__((deprecated)) |
Removes the device selected by DeviceId from the data model. | |
typedef void(* | CircuitRemoveDevice_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) __attribute__((deprecated)) |
Removes the device selected by DeviceId from the data model. | |
typedef void(* | CircuitRemoveInactiveDevices_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes inactive devices from the data model. | |
typedef void(* | CircuitRemoveInactiveDevices_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes inactive devices from the data model. | |
typedef void(* | DeviceActionRequest_action_blink_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_blink_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_call_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_call_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_force_call_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_force_call_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_programming_mode_off_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_programming_mode_off_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_programming_mode_on_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_programming_mode_on_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_save_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_save_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_set_outval_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_set_outval_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_undo_scene_number_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_undo_scene_number_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_undo_scene_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device. | |
typedef void(* | DeviceActionRequest_action_undo_scene_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device. | |
typedef void(* | DeviceButtonInfo_by_device_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Returns the state of the button of a device. | |
typedef void(* | DeviceButtonInfo_by_device_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ButtonId, uint8_t GroupMembership, uint8_t Group, uint8_t SetLocalPriority) |
Returns the state of the button of a device. | |
typedef void(* | DeviceConfig_get_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex) |
Read a configuration parameter of a specific digitalSTROM device. | |
typedef void(* | DeviceConfig_get_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Read a configuration parameter of a specific digitalSTROM device. | |
typedef void(* | DeviceConfig_set_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex, uint8_t Value) |
Write a configuration parameter of a specific digitalSTROM device. | |
typedef void(* | DeviceConfig_set_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Write a configuration parameter of a specific digitalSTROM device. | |
typedef void(* | DeviceGroupMembershipModify_add_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t GroupId) |
Add the device to this group. | |
typedef void(* | DeviceGroupMembershipModify_add_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Add the device to this group. | |
typedef void(* | DeviceGroupMembershipModify_remove_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t GroupId) |
remove the device from this group. | |
typedef void(* | DeviceGroupMembershipModify_remove_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
remove the device from this group. | |
typedef void(* | DeviceInfo_by_device_id_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceIdReq) |
Returns the properties of a device. | |
typedef void(* | DeviceInfo_by_device_id_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device. | |
typedef void(* | DeviceInfo_by_index_only_active_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq, uint16_t DeviceIndex) |
Returns the properties of a device. | |
typedef void(* | DeviceInfo_by_index_only_active_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device. | |
typedef void(* | DeviceInfo_by_index_only_inactive_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq, uint16_t DeviceIndex) |
Returns the properties of a device. | |
typedef void(* | DeviceInfo_by_index_only_inactive_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device. | |
typedef void(* | DeviceInfo_by_index_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq, uint16_t DeviceIndex) |
Returns the properties of a device. | |
typedef void(* | DeviceInfo_by_index_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device. | |
typedef void(* | DeviceProperties_reset_button_active_group_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Reset active group of button to default. | |
typedef void(* | DeviceProperties_reset_button_active_group_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Reset active group of button to default. | |
typedef void(* | DeviceProperties_set_button_active_group_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t GroupId) |
Define the active group for the button of the device. | |
typedef void(* | DeviceProperties_set_button_active_group_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Define the active group for the button of the device. | |
typedef void(* | DeviceProperties_set_button_set_local_priority_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SetLocalPriority) |
Set if the button triggers the local priority. | |
typedef void(* | DeviceProperties_set_button_set_local_priority_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Set if the button triggers the local priority. | |
typedef void(* | DeviceProperties_set_locked_flag_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t LockedFlag) |
A locked device will not become inactive. | |
typedef void(* | DeviceProperties_set_locked_flag_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
A locked device will not become inactive. | |
typedef void(* | DeviceProperties_set_name_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, const uint8_t *Name) |
Set the name of the device. | |
typedef void(* | DeviceProperties_set_name_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Set the name of the device. | |
typedef void(* | DeviceProperties_set_zone_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId) |
Move the device into a new zone. | |
typedef void(* | DeviceProperties_set_zone_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Move the device into a new zone. | |
typedef void(* | DeviceSensor_get_type_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex) |
Access device sensors. | |
typedef void(* | DeviceSensor_get_type_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Access device sensors. | |
typedef void(* | DeviceSensor_get_value_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex) |
Access device sensors. | |
typedef void(* | DeviceSensor_get_value_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Access device sensors. | |
typedef void(* | DeviceState_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Returns the state of a device. | |
typedef void(* | DeviceState_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ActiveFlag) |
Returns the state of a device. | |
typedef void(* | DeviceStatisticsRequest_get_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ParamOffset) |
Requests statistics data of a device. | |
typedef void(* | DeviceStatisticsRequest_get_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Requests statistics data of a device. | |
typedef void(* | EventDeviceAccessibility_off_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint16_t VendorId, uint32_t SerialNumber) |
Device is now inactive. | |
typedef void(* | EventDeviceAccessibility_on_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint16_t VendorId, uint32_t SerialNumber) |
Device is now active. | |
typedef void(* | EventDeviceAction_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint8_t GroupId, uint8_t ButtonNr, uint8_t ClickType) |
Sent by the dSM if a button click was received on a group with no associated usage model (StateMachineGroupId). | |
typedef void(* | EventDeviceConfig_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex, uint8_t Value) |
Parameter response of a device. | |
typedef void(* | EventDeviceGiveUp_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t SerialNumber, uint8_t CircuitId) |
A device gives up its attempts to register with the dSM. | |
typedef void(* | EventDeviceLocalAction_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint8_t State) |
Device was switched locally. | |
typedef void(* | EventDeviceModelChanged_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Device was changed. | |
typedef void(* | EventDeviceSensor_event_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t EventIndex) |
Sensor event. | |
typedef void(* | EventDeviceSensor_type_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex, uint8_t SensorPresent, uint8_t SensorType, uint8_t LastSensor) |
Response to a sensor type request. | |
typedef void(* | EventDeviceSensor_value_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex, uint16_t SensorValue) |
Response to a sensor value request. | |
typedef void(* | EventDeviceStatistics_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Offset, uint16_t Value) |
Statistics data of a device. | |
typedef void(* | EventTestDevicePresence_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Present) |
Result of the TestDevicePresence call. | |
typedef void(* | EventTestTransmissionQuality_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t DownstreamQuality, uint16_t UpstreamQuality) |
Result of the TestTransmissionQuality_get call. | |
typedef void(* | TestDevicePresence_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Ping a single device. | |
typedef void(* | TestDevicePresence_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Ping a single device. | |
typedef void(* | TestTransmissionQuality_get_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Query transmission quality. | |
typedef void(* | TestTransmissionQuality_get_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Query transmission quality. | |
Functions | |
int | CircuitRemoveDevice (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) __attribute__((deprecated)) |
Removes the device selected by DeviceId from the data model. | |
int | CircuitRemoveDevice_by_dsid (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t SerialNumber) |
Removes the device selected by dSID from the data model. | |
int | CircuitRemoveDevice_by_id (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Removes the device selected by DeviceId from the data model. | |
int | CircuitRemoveInactiveDevices (DsmApiHandle_t handle, dsid_t dSMdSID) |
Removes inactive devices from the data model. | |
int | DeviceActionRequest_action_blink (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_call_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_force_call_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_programming_mode_off (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_programming_mode_on (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_save_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_set_outval (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t Value) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_undo_scene (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Execute actions on a single device. | |
int | DeviceActionRequest_action_undo_scene_number (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device. | |
int | DeviceButtonInfo_by_device (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t *ButtonId, uint8_t *GroupMembership, uint8_t *Group, uint8_t *SetLocalPriority) |
Returns the state of the button of a device. | |
int | DeviceConfig_get (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex) |
Read a configuration parameter of a specific digitalSTROM device. | |
int | DeviceConfig_get_sync_16 (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex, int timeout, uint16_t *Value) |
Read two configuration parameters of a specific digitalSTROM device simultaneously. | |
int | DeviceConfig_get_sync_8 (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex, int timeout, uint8_t *Value) |
Read a configuration parameter of a specific digitalSTROM device. | |
int | DeviceConfig_set (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex, uint8_t Value) |
Write a configuration parameter of a specific digitalSTROM device. | |
int | DeviceGroupMembershipModify_add (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t GroupId) |
Add the device to this group. | |
int | DeviceGroupMembershipModify_remove (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t GroupId) |
remove the device from this group. | |
int | DeviceInfo_by_device_id (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceIdReq, uint16_t *DeviceId, uint16_t *VendorId, uint16_t *ProductId, uint16_t *FunctionId, uint16_t *Version, uint16_t *ZoneId, uint8_t *State, uint8_t *Locked, uint8_t *OutputMode, uint8_t *LTMode, uint8_t *Groups, uint8_t *Name, uint32_t *SerialNumber) |
Returns the properties of a device. | |
int | DeviceInfo_by_index (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneIdReq, uint16_t DeviceIndex, uint16_t *DeviceId, uint16_t *VendorId, uint16_t *ProductId, uint16_t *FunctionId, uint16_t *Version, uint16_t *ZoneId, uint8_t *State, uint8_t *Locked, uint8_t *OutputMode, uint8_t *LTMode, uint8_t *Groups, uint8_t *Name, uint32_t *SerialNumber) |
Returns the properties of a device. | |
int | DeviceInfo_by_index_only_active (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneIdReq, uint16_t DeviceIndex, uint16_t *DeviceId, uint16_t *VendorId, uint16_t *ProductId, uint16_t *FunctionId, uint16_t *Version, uint16_t *ZoneId, uint8_t *State, uint8_t *Locked, uint8_t *OutputMode, uint8_t *LTMode, uint8_t *Groups, uint8_t *Name, uint32_t *SerialNumber) |
Returns the properties of a device. | |
int | DeviceInfo_by_index_only_inactive (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ZoneIdReq, uint16_t DeviceIndex, uint16_t *DeviceId, uint16_t *VendorId, uint16_t *ProductId, uint16_t *FunctionId, uint16_t *Version, uint16_t *ZoneId, uint8_t *State, uint8_t *Locked, uint8_t *OutputMode, uint8_t *LTMode, uint8_t *Groups, uint8_t *Name, uint32_t *SerialNumber) |
Returns the properties of a device. | |
int | DeviceProperties_reset_button_active_group (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Reset active group of button to default. | |
int | DeviceProperties_set_button_active_group (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t GroupId) |
Define the active group for the button of the device. | |
int | DeviceProperties_set_button_set_local_priority (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SetLocalPriority) |
Set if the button triggers the local priority. | |
int | DeviceProperties_set_locked_flag (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t LockedFlag) |
A locked device will not become inactive. | |
int | DeviceProperties_set_name (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, const uint8_t *Name) |
Set the name of the device. | |
int | DeviceProperties_set_zone (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint16_t ZoneId) |
Move the device into a new zone. | |
int | DeviceSensor_get_type (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SensorIndex) |
Access device sensors. | |
int | DeviceSensor_get_type_sync (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SensorIndex, int timeout, uint8_t *SensorPresent, uint8_t *SensorType, uint8_t *LastSensor) |
Access device sensors. | |
int | DeviceSensor_get_value (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SensorIndex) |
Access device sensors. | |
int | DeviceSensor_get_value_sync (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t SensorIndex, int timeout, uint16_t *SensorValue) |
Access device sensors. | |
int | DeviceState (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t *ActiveFlag) |
Returns the state of a device. | |
int | DeviceStatisticsRequest_get (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t ParamOffset) |
Requests statistics data of a device. | |
int | DeviceStatisticsRequest_get_sync (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, uint8_t ParamOffset, int timeout, uint16_t *Value) |
Requests statistics data of a device. | |
int | TestDevicePresence (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Ping a single device. | |
int | TestTransmissionQuality_get (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId) |
Query transmission quality. | |
int | TestTransmissionQuality_get_sync (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t DeviceId, int timeout, uint8_t *DownstreamQuality, uint16_t *UpstreamQuality) |
Query transmission quality. |
This group of API calls addresses single devices and their properties.
typedef void(* CircuitRemoveDevice_by_dsid_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t SerialNumber) |
Removes the device selected by dSID from the data model.
Request callback function prototype for call CircuitRemoveDevice_by_dsid.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = CIRCUIT_REMOVE_DEVICE and ModifierId = CIRCUIT_REMOVE_DEVICE_BY_DSID
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | SerialNumber | SerialNumber part of the dSID. |
typedef void(* CircuitRemoveDevice_by_dsid_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes the device selected by dSID from the data model.
Response callback function prototype for call CircuitRemoveDevice_by_dsid.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = CIRCUIT_REMOVE_DEVICE and ModifierId = CIRCUIT_REMOVE_DEVICE_BY_DSID
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* CircuitRemoveDevice_by_id_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Removes the device selected by DeviceId from the data model.
Request callback function prototype for call CircuitRemoveDevice_by_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = CIRCUIT_REMOVE_DEVICE and ModifierId = CIRCUIT_REMOVE_DEVICE_BY_ID
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* CircuitRemoveDevice_by_id_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes the device selected by DeviceId from the data model.
Response callback function prototype for call CircuitRemoveDevice_by_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = CIRCUIT_REMOVE_DEVICE and ModifierId = CIRCUIT_REMOVE_DEVICE_BY_ID
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* CircuitRemoveDevice_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) __attribute__((deprecated)) |
Removes the device selected by DeviceId from the data model.
Request callback function prototype for call CircuitRemoveDevice.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = CIRCUIT_REMOVE_DEVICE and ModifierId = CIRCUIT_REMOVE_DEVICE_
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* CircuitRemoveDevice_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) __attribute__((deprecated)) |
Removes the device selected by DeviceId from the data model.
Response callback function prototype for call CircuitRemoveDevice.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = CIRCUIT_REMOVE_DEVICE and ModifierId = CIRCUIT_REMOVE_DEVICE_
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* CircuitRemoveInactiveDevices_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes inactive devices from the data model.
Request callback function prototype for call CircuitRemoveInactiveDevices.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = CIRCUIT_REMOVE_INACTIVE_DEVICES and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* CircuitRemoveInactiveDevices_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Removes inactive devices from the data model.
Response callback function prototype for call CircuitRemoveInactiveDevices.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = CIRCUIT_REMOVE_INACTIVE_DEVICES and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_blink_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device.
Let the device blink its load.
Request callback function prototype for call DeviceActionRequest_action_blink.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_BLINK
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* DeviceActionRequest_action_blink_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Let the device blink its load.
Response callback function prototype for call DeviceActionRequest_action_blink.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_BLINK
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_call_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device.
Call a scene.
Request callback function prototype for call DeviceActionRequest_action_call_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_CALL_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
typedef void(* DeviceActionRequest_action_call_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Call a scene.
Response callback function prototype for call DeviceActionRequest_action_call_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_CALL_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_force_call_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device.
Call a scene. Overwrite any locally selected state.
Request callback function prototype for call DeviceActionRequest_action_force_call_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
typedef void(* DeviceActionRequest_action_force_call_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Call a scene. Overwrite any locally selected state.
Response callback function prototype for call DeviceActionRequest_action_force_call_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_programming_mode_off_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device.
Finish programming mode.
Request callback function prototype for call DeviceActionRequest_action_programming_mode_off.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* DeviceActionRequest_action_programming_mode_off_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Finish programming mode.
Response callback function prototype for call DeviceActionRequest_action_programming_mode_off.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_programming_mode_on_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device.
Start Programming mode.
Request callback function prototype for call DeviceActionRequest_action_programming_mode_on.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* DeviceActionRequest_action_programming_mode_on_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Start Programming mode.
Response callback function prototype for call DeviceActionRequest_action_programming_mode_on.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_save_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device.
Save the current state in given scene.
Request callback function prototype for call DeviceActionRequest_action_save_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_SAVE_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
typedef void(* DeviceActionRequest_action_save_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Save the current state in given scene.
Response callback function prototype for call DeviceActionRequest_action_save_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_SAVE_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_set_outval_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Value) |
Execute actions on a single device.
Set the output to the given value independent of any scene configurations.
Request callback function prototype for call DeviceActionRequest_action_set_outval.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_SET_OUTVAL
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | Value | Output value (0-255). |
typedef void(* DeviceActionRequest_action_set_outval_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Set the output to the given value independent of any scene configurations.
Response callback function prototype for call DeviceActionRequest_action_set_outval.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_SET_OUTVAL
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_undo_scene_number_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SceneId) |
Execute actions on a single device.
Instruct the device to undo the last scene call if it was the scene with the given scene ID.
Request callback function prototype for call DeviceActionRequest_action_undo_scene_number.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
typedef void(* DeviceActionRequest_action_undo_scene_number_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Instruct the device to undo the last scene call if it was the scene with the given scene ID.
Response callback function prototype for call DeviceActionRequest_action_undo_scene_number.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceActionRequest_action_undo_scene_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Execute actions on a single device.
Instruct the device to undo the last scene call.
Request callback function prototype for call DeviceActionRequest_action_undo_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* DeviceActionRequest_action_undo_scene_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Execute actions on a single device.
Instruct the device to undo the last scene call.
Response callback function prototype for call DeviceActionRequest_action_undo_scene.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_ACTION_REQUEST and ModifierId = DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceButtonInfo_by_device_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Returns the state of the button of a device.
Select the device by DeviceId.
Request callback function prototype for call DeviceButtonInfo_by_device.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_BUTTON_INFO and ModifierId = DEVICE_BUTTON_INFO_BY_DEVICE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* DeviceButtonInfo_by_device_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ButtonId, uint8_t GroupMembership, uint8_t Group, uint8_t SetLocalPriority) |
Returns the state of the button of a device.
Select the device by DeviceId.
Response callback function prototype for call DeviceButtonInfo_by_device.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_BUTTON_INFO and ModifierId = DEVICE_BUTTON_INFO_BY_DEVICE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | ButtonId | Button Id from LTNUMGRP0 |
[in] | GroupMembership | Group Membership of Button from LTNUMGRP0 |
[in] | Group | Buttons active group |
[in] | SetLocalPriority | 0=Button does not trigger a SetLocalPriority, 1=Button triggers a SetLocalPriority |
typedef void(* DeviceConfig_get_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex) |
Read a configuration parameter of a specific digitalSTROM device.
The response is returned asynchronously with an EventDeviceConfig_event_callback_t. DeviceConfig_get_sync_8 and DeviceConfig_get_sync_16 are synchronous convenience functions with the same functionality.
Request callback function prototype for call DeviceConfig_get.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_CONFIG and ModifierId = DEVICE_CONFIG_GET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | ConfigClass | Configuration class (Bank). |
[in] | ConfigIndex | Index in class. |
typedef void(* DeviceConfig_get_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Read a configuration parameter of a specific digitalSTROM device.
The response is returned asynchronously with an EventDeviceConfig_event_callback_t. DeviceConfig_get_sync_8 and DeviceConfig_get_sync_16 are synchronous convenience functions with the same functionality.
Response callback function prototype for call DeviceConfig_get.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_CONFIG and ModifierId = DEVICE_CONFIG_GET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceConfig_set_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex, uint8_t Value) |
Write a configuration parameter of a specific digitalSTROM device.
Request callback function prototype for call DeviceConfig_set.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_CONFIG and ModifierId = DEVICE_CONFIG_SET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | ConfigClass | Configuration class (Bank). |
[in] | ConfigIndex | Index in class. |
[in] | Value | Parameter value. |
typedef void(* DeviceConfig_set_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Write a configuration parameter of a specific digitalSTROM device.
Response callback function prototype for call DeviceConfig_set.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_CONFIG and ModifierId = DEVICE_CONFIG_SET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceGroupMembershipModify_add_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t GroupId) |
Add the device to this group.
Request callback function prototype for call DeviceGroupMembershipModify_add.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_GROUP_MEMBERSHIP_MODIFY and ModifierId = DEVICE_GROUP_MEMBERSHIP_MODIFY_ADD
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | GroupId | Group ID. |
typedef void(* DeviceGroupMembershipModify_add_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Add the device to this group.
Response callback function prototype for call DeviceGroupMembershipModify_add.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_GROUP_MEMBERSHIP_MODIFY and ModifierId = DEVICE_GROUP_MEMBERSHIP_MODIFY_ADD
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceGroupMembershipModify_remove_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t GroupId) |
remove the device from this group.
Request callback function prototype for call DeviceGroupMembershipModify_remove.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_GROUP_MEMBERSHIP_MODIFY and ModifierId = DEVICE_GROUP_MEMBERSHIP_MODIFY_REMOVE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | GroupId | Group ID. |
typedef void(* DeviceGroupMembershipModify_remove_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
remove the device from this group.
Response callback function prototype for call DeviceGroupMembershipModify_remove.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_GROUP_MEMBERSHIP_MODIFY and ModifierId = DEVICE_GROUP_MEMBERSHIP_MODIFY_REMOVE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceInfo_by_device_id_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceIdReq) |
Returns the properties of a device.
Select the device by device ID.
Request callback function prototype for call DeviceInfo_by_device_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_DEVICE_ID
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceIdReq | Device ID. |
typedef void(* DeviceInfo_by_device_id_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device.
Select the device by device ID.
Response callback function prototype for call DeviceInfo_by_device_id.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_DEVICE_ID
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device identifier in the digitalSTROM network. |
[in] | VendorId | Device vendor identification. |
[in] | ProductId | Product identifier. |
[in] | FunctionId | Functionality declaration. |
[in] | Version | Device software version |
[in] | ZoneId | Device is member of this zone. |
[in] | State | 0=Inactive, 1=Active |
[in] | Locked | 0=Not locked, 1=Locked |
[in] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[in] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[in] | Groups | Bitfield of group memberships. 1=Group member |
[in] | Name | Device name (21 character, zero terminated string). |
[in] | SerialNumber | SerialNumber |
typedef void(* DeviceInfo_by_index_only_active_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq, uint16_t DeviceIndex) |
Returns the properties of a device.
Select the device sequentially from all active devices of a zone (0 based).
Request callback function prototype for call DeviceInfo_by_index_only_active.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_INDEX_ONLY_ACTIVE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | ZoneIdReq | 0 for all zones |
[in] | DeviceIndex | 0 .. ZoneDeviceCount |
typedef void(* DeviceInfo_by_index_only_active_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device.
Select the device sequentially from all active devices of a zone (0 based).
Response callback function prototype for call DeviceInfo_by_index_only_active.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_INDEX_ONLY_ACTIVE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device identifier in the digitalSTROM network. |
[in] | VendorId | Device vendor identification. |
[in] | ProductId | Product identifier. |
[in] | FunctionId | Functionality declaration. |
[in] | Version | Device software version |
[in] | ZoneId | Device is member of this zone. |
[in] | State | 0=Inactive, 1=Active |
[in] | Locked | 0=Not locked, 1=Locked |
[in] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[in] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[in] | Groups | Bitfield of group memberships. 1=Group member |
[in] | Name | Device name (21 character, zero terminated string). |
[in] | SerialNumber | SerialNumber |
typedef void(* DeviceInfo_by_index_only_inactive_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq, uint16_t DeviceIndex) |
Returns the properties of a device.
Select the device sequentially from all inactive devices of a zone (0 based).
Request callback function prototype for call DeviceInfo_by_index_only_inactive.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_INDEX_ONLY_INACTIVE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | ZoneIdReq | 0 for all zones |
[in] | DeviceIndex | 0 .. ZoneDeviceCount |
typedef void(* DeviceInfo_by_index_only_inactive_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device.
Select the device sequentially from all inactive devices of a zone (0 based).
Response callback function prototype for call DeviceInfo_by_index_only_inactive.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_INDEX_ONLY_INACTIVE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device identifier in the digitalSTROM network. |
[in] | VendorId | Device vendor identification. |
[in] | ProductId | Product identifier. |
[in] | FunctionId | Functionality declaration. |
[in] | Version | Device software version |
[in] | ZoneId | Device is member of this zone. |
[in] | State | 0=Inactive, 1=Active |
[in] | Locked | 0=Not locked, 1=Locked |
[in] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[in] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[in] | Groups | Bitfield of group memberships. 1=Group member |
[in] | Name | Device name (21 character, zero terminated string). |
[in] | SerialNumber | SerialNumber |
typedef void(* DeviceInfo_by_index_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ZoneIdReq, uint16_t DeviceIndex) |
Returns the properties of a device.
Select the device sequentially from all devices of a zone (0 based).
Request callback function prototype for call DeviceInfo_by_index.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_INDEX
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | ZoneIdReq | 0 for all zones |
[in] | DeviceIndex | 0 .. ZoneDeviceCount |
typedef void(* DeviceInfo_by_index_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t VendorId, uint16_t ProductId, uint16_t FunctionId, uint16_t Version, uint16_t ZoneId, uint8_t State, uint8_t Locked, uint8_t OutputMode, uint8_t LTMode, const uint8_t *Groups, const uint8_t *Name, uint32_t SerialNumber) |
Returns the properties of a device.
Select the device sequentially from all devices of a zone (0 based).
Response callback function prototype for call DeviceInfo_by_index.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_INFO and ModifierId = DEVICE_INFO_BY_INDEX
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device identifier in the digitalSTROM network. |
[in] | VendorId | Device vendor identification. |
[in] | ProductId | Product identifier. |
[in] | FunctionId | Functionality declaration. |
[in] | Version | Device software version |
[in] | ZoneId | Device is member of this zone. |
[in] | State | 0=Inactive, 1=Active |
[in] | Locked | 0=Not locked, 1=Locked |
[in] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[in] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[in] | Groups | Bitfield of group memberships. 1=Group member |
[in] | Name | Device name (21 character, zero terminated string). |
[in] | SerialNumber | SerialNumber |
typedef void(* DeviceProperties_reset_button_active_group_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Reset active group of button to default.
Request callback function prototype for call DeviceProperties_reset_button_active_group.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_RESET_BUTTON_ACTIVE_GROUP
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* DeviceProperties_reset_button_active_group_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Reset active group of button to default.
Response callback function prototype for call DeviceProperties_reset_button_active_group.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_RESET_BUTTON_ACTIVE_GROUP
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceProperties_set_button_active_group_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t GroupId) |
Define the active group for the button of the device.
Request callback function prototype for call DeviceProperties_set_button_active_group.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_BUTTON_ACTIVE_GROUP
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | GroupId | Active group ID for this button (1-63). |
typedef void(* DeviceProperties_set_button_active_group_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Define the active group for the button of the device.
Response callback function prototype for call DeviceProperties_set_button_active_group.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_BUTTON_ACTIVE_GROUP
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceProperties_set_button_set_local_priority_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SetLocalPriority) |
Set if the button triggers the local priority.
Request callback function prototype for call DeviceProperties_set_button_set_local_priority.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_BUTTON_SET_LOCAL_PRIORITY
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | SetLocalPriority | 0=Button does not trigger a SetLocalPriority, 1=Button triggers a SetLocalPriority. |
typedef void(* DeviceProperties_set_button_set_local_priority_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Set if the button triggers the local priority.
Response callback function prototype for call DeviceProperties_set_button_set_local_priority.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_BUTTON_SET_LOCAL_PRIORITY
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceProperties_set_locked_flag_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t LockedFlag) |
A locked device will not become inactive.
Request callback function prototype for call DeviceProperties_set_locked_flag.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_LOCKED_FLAG
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | LockedFlag | 0=not locked, 1=locked. |
typedef void(* DeviceProperties_set_locked_flag_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
A locked device will not become inactive.
Response callback function prototype for call DeviceProperties_set_locked_flag.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_LOCKED_FLAG
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceProperties_set_name_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, const uint8_t *Name) |
Set the name of the device.
Request callback function prototype for call DeviceProperties_set_name.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_NAME
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | Name | New name of the device (21 character, zero terminated string). |
typedef void(* DeviceProperties_set_name_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Set the name of the device.
Response callback function prototype for call DeviceProperties_set_name.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_NAME
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceProperties_set_zone_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId) |
Move the device into a new zone.
Request callback function prototype for call DeviceProperties_set_zone.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_ZONE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | ZoneId | Add device to this zone. |
typedef void(* DeviceProperties_set_zone_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Move the device into a new zone.
Response callback function prototype for call DeviceProperties_set_zone.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_PROPERTIES and ModifierId = DEVICE_PROPERTIES_SET_ZONE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceSensor_get_type_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex) |
Access device sensors.
Get the type of sensor SensorIndex. Value is returned with event callback EventDeviceSensor_type_event_callback_t.
Request callback function prototype for call DeviceSensor_get_type.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_SENSOR and ModifierId = DEVICE_SENSOR_GET_TYPE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | SensorIndex | Index of the requested sensor on the device. |
typedef void(* DeviceSensor_get_type_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Access device sensors.
Get the type of sensor SensorIndex. Value is returned with event callback EventDeviceSensor_type_event_callback_t.
Response callback function prototype for call DeviceSensor_get_type.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_SENSOR and ModifierId = DEVICE_SENSOR_GET_TYPE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceSensor_get_value_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex) |
Access device sensors.
Get the value of sensor SensorIndex. Value is returned with event callback EventDeviceSensor_value_event_callback_t. DeviceSensor_get_value_sync is a synchronous convenience function with the same functionality.
Request callback function prototype for call DeviceSensor_get_value.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_SENSOR and ModifierId = DEVICE_SENSOR_GET_VALUE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | SensorIndex | Index of the requested sensor on the device. |
typedef void(* DeviceSensor_get_value_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Access device sensors.
Get the value of sensor SensorIndex. Value is returned with event callback EventDeviceSensor_value_event_callback_t. DeviceSensor_get_value_sync is a synchronous convenience function with the same functionality.
Response callback function prototype for call DeviceSensor_get_value.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_SENSOR and ModifierId = DEVICE_SENSOR_GET_VALUE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* DeviceState_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Returns the state of a device.
Request callback function prototype for call DeviceState.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_STATE and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* DeviceState_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ActiveFlag) |
Returns the state of a device.
Response callback function prototype for call DeviceState.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_STATE and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | ActiveFlag | 0=inactive, 1=active. |
typedef void(* DeviceStatisticsRequest_get_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ParamOffset) |
Requests statistics data of a device.
Response data is sent with an event (EventDeviceStatistics_event_callback_t). DeviceStatisticsRequest_get_sync is a synchronous convenience function with the same functionality.
Request callback function prototype for call DeviceStatisticsRequest_get.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DEVICE_STATISTICS_REQUEST and ModifierId = DEVICE_STATISTICS_REQUEST_GET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | ParamOffset | Index in statistics structure. |
typedef void(* DeviceStatisticsRequest_get_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Requests statistics data of a device.
Response data is sent with an event (EventDeviceStatistics_event_callback_t). DeviceStatisticsRequest_get_sync is a synchronous convenience function with the same functionality.
Response callback function prototype for call DeviceStatisticsRequest_get.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DEVICE_STATISTICS_REQUEST and ModifierId = DEVICE_STATISTICS_REQUEST_GET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* EventDeviceAccessibility_off_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint16_t VendorId, uint32_t SerialNumber) |
Device is now inactive.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_ACCESSIBILITY and ModifierId = EVENT_DEVICE_ACCESSIBILITY_OFF
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device identifier in the digitalSTROM network. |
[in] | ZoneId | Zone of the device. |
[in] | VendorId | VendorId |
[in] | SerialNumber | SerialNumber |
typedef void(* EventDeviceAccessibility_on_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint16_t VendorId, uint32_t SerialNumber) |
Device is now active.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_ACCESSIBILITY and ModifierId = EVENT_DEVICE_ACCESSIBILITY_ON
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device identifier in the digitalSTROM network. |
[in] | ZoneId | Zone of the device. |
[in] | VendorId | VendorId |
[in] | SerialNumber | SerialNumber |
typedef void(* EventDeviceAction_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint8_t GroupId, uint8_t ButtonNr, uint8_t ClickType) |
Sent by the dSM if a button click was received on a group with no associated usage model (StateMachineGroupId).
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_ACTION and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | ZoneId | Zone of the device. |
[in] | GroupId | Group of the button. |
[in] | ButtonNr | Button number. |
[in] | ClickType | Click type. |
typedef void(* EventDeviceConfig_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t ConfigClass, uint8_t ConfigIndex, uint8_t Value) |
Parameter response of a device.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_CONFIG and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | ConfigClass | Configuration class (Bank). |
[in] | ConfigIndex | Index in class. |
[in] | Value | Parameter value. |
typedef void(* EventDeviceGiveUp_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t SerialNumber, uint8_t CircuitId) |
A device gives up its attempts to register with the dSM.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_GIVE_UP and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | SerialNumber | SerialNumber of the device giving up. |
[in] | CircuitId | CircuitId |
typedef void(* EventDeviceLocalAction_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint16_t ZoneId, uint8_t State) |
Device was switched locally.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_LOCAL_ACTION and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | ZoneId | Zone of the device. |
[in] | State | 0=local off; 1=local on |
typedef void(* EventDeviceModelChanged_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Device was changed.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_MODEL_CHANGED and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* EventDeviceSensor_event_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t EventIndex) |
Sensor event.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_SENSOR and ModifierId = EVENT_DEVICE_SENSOR_EVENT
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | DeviceId |
[in] | EventIndex | Index of the sensor event according to the device event table. |
typedef void(* EventDeviceSensor_type_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex, uint8_t SensorPresent, uint8_t SensorType, uint8_t LastSensor) |
Response to a sensor type request.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_SENSOR and ModifierId = EVENT_DEVICE_SENSOR_TYPE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | DeviceId |
[in] | SensorIndex | Index of the requested sensor on the device. |
[in] | SensorPresent | 0=sensor available, 1=no sensor at this index. |
[in] | SensorType | Sensor type |
[in] | LastSensor | 0=Last sensor: no additional sensors at higher indices, 1=additional sensor present. |
typedef void(* EventDeviceSensor_value_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t SensorIndex, uint16_t SensorValue) |
Response to a sensor value request.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_SENSOR and ModifierId = EVENT_DEVICE_SENSOR_VALUE
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | DeviceId |
[in] | SensorIndex | Index of the requested sensor on the device. |
[in] | SensorValue | Current value of the sensor (12 bit). |
typedef void(* EventDeviceStatistics_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Offset, uint16_t Value) |
Statistics data of a device.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DEVICE_STATISTICS and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
[in] | Offset | Statistics offset. |
[in] | Value | Statistics value. |
typedef void(* EventTestDevicePresence_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t Present) |
Result of the TestDevicePresence call.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_TEST_DEVICE_PRESENCE and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID of the answering device. |
[in] | Present | True if device was successfully pinged, false otherwise. |
typedef void(* EventTestTransmissionQuality_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t DownstreamQuality, uint16_t UpstreamQuality) |
Result of the TestTransmissionQuality_get call.
Event callback function prototype.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_TEST_TRANSMISSION_QUALITY and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID of the answering device. |
[in] | DownstreamQuality | Bit-Error-Rate (BER) on the downstream channel. |
[in] | UpstreamQuality | Reception quality on the upstream channel. |
typedef void(* TestDevicePresence_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Ping a single device.
Answer is returned with a EventTestDevicePresence_event_callback_t event.
Request callback function prototype for call TestDevicePresence.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = TEST_DEVICE_PRESENCE and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* TestDevicePresence_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Ping a single device.
Answer is returned with a EventTestDevicePresence_event_callback_t event.
Response callback function prototype for call TestDevicePresence.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = TEST_DEVICE_PRESENCE and ModifierId = #0
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
typedef void(* TestTransmissionQuality_get_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId) |
Query transmission quality.
Answer is returned with a EventTestTransmissionQuality_event_callback_t event. TestTransmissionQuality_get_sync is a synchronous convenience function with the same functionality.
Request callback function prototype for call TestTransmissionQuality_get.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = TEST_TRANSMISSION_QUALITY and ModifierId = TEST_TRANSMISSION_QUALITY_GET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
[in] | DeviceId | Device ID. |
typedef void(* TestTransmissionQuality_get_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId) |
Query transmission quality.
Answer is returned with a EventTestTransmissionQuality_event_callback_t event. TestTransmissionQuality_get_sync is a synchronous convenience function with the same functionality.
Response callback function prototype for call TestTransmissionQuality_get.
To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = TEST_TRANSMISSION_QUALITY and ModifierId = TEST_TRANSMISSION_QUALITY_GET
[in] | error | Error result of the (potential) previous call. |
[in] | arg | User data |
[in] | sourceId | Source address of the call |
[in] | destinationId | Destination address of the call |
int CircuitRemoveDevice | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Removes the device selected by DeviceId from the data model.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the CircuitRemoveDevice_response_callback_t callback. To receive this request from other bus members register the CircuitRemoveDevice_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int CircuitRemoveDevice_by_dsid | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint32_t | SerialNumber | ||
) |
Removes the device selected by dSID from the data model.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the CircuitRemoveDevice_by_dsid_response_callback_t callback. To receive this request from other bus members register the CircuitRemoveDevice_by_dsid_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | SerialNumber | SerialNumber part of the dSID. |
int CircuitRemoveDevice_by_id | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Removes the device selected by DeviceId from the data model.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the CircuitRemoveDevice_by_id_response_callback_t callback. To receive this request from other bus members register the CircuitRemoveDevice_by_id_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int CircuitRemoveInactiveDevices | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID | ||
) |
Removes inactive devices from the data model.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the CircuitRemoveInactiveDevices_response_callback_t callback. To receive this request from other bus members register the CircuitRemoveInactiveDevices_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
int DeviceActionRequest_action_blink | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Execute actions on a single device.
Let the device blink its load.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_blink_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_blink_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int DeviceActionRequest_action_call_scene | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SceneId | ||
) |
Execute actions on a single device.
Call a scene.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_call_scene_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_call_scene_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
int DeviceActionRequest_action_force_call_scene | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SceneId | ||
) |
Execute actions on a single device.
Call a scene. Overwrite any locally selected state.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_force_call_scene_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_force_call_scene_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
int DeviceActionRequest_action_programming_mode_off | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Execute actions on a single device.
Finish programming mode.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_programming_mode_off_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_programming_mode_off_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int DeviceActionRequest_action_programming_mode_on | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Execute actions on a single device.
Start Programming mode.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_programming_mode_on_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_programming_mode_on_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int DeviceActionRequest_action_save_scene | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SceneId | ||
) |
Execute actions on a single device.
Save the current state in given scene.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_save_scene_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_save_scene_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
int DeviceActionRequest_action_set_outval | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | Value | ||
) |
Execute actions on a single device.
Set the output to the given value independent of any scene configurations.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_set_outval_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_set_outval_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | Value | Output value (0-255). |
int DeviceActionRequest_action_undo_scene | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Execute actions on a single device.
Instruct the device to undo the last scene call.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_undo_scene_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_undo_scene_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int DeviceActionRequest_action_undo_scene_number | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SceneId | ||
) |
Execute actions on a single device.
Instruct the device to undo the last scene call if it was the scene with the given scene ID.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceActionRequest_action_undo_scene_number_response_callback_t callback. To receive this request from other bus members register the DeviceActionRequest_action_undo_scene_number_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | SceneId | Scene ID. |
int DeviceButtonInfo_by_device | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t * | ButtonId, | ||
uint8_t * | GroupMembership, | ||
uint8_t * | Group, | ||
uint8_t * | SetLocalPriority | ||
) |
Returns the state of the button of a device.
Select the device by DeviceId.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceButtonInfo_by_device_response_callback_t callback. To receive this request from other bus members register the DeviceButtonInfo_by_device_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[out] | ButtonId | Button Id from LTNUMGRP0 |
[out] | GroupMembership | Group Membership of Button from LTNUMGRP0 |
[out] | Group | Buttons active group |
[out] | SetLocalPriority | 0=Button does not trigger a SetLocalPriority, 1=Button triggers a SetLocalPriority |
int DeviceConfig_get | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | ConfigClass, | ||
uint8_t | ConfigIndex | ||
) |
Read a configuration parameter of a specific digitalSTROM device.
The response is returned asynchronously with an EventDeviceConfig_event_callback_t. DeviceConfig_get_sync_8 and DeviceConfig_get_sync_16 are synchronous convenience functions with the same functionality.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceConfig_get_response_callback_t callback. To receive this request from other bus members register the DeviceConfig_get_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | ConfigClass | Configuration class (Bank). |
[in] | ConfigIndex | Index in class. |
int DeviceConfig_get_sync_16 | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | ConfigClass, | ||
uint8_t | ConfigIndex, | ||
int | timeout, | ||
uint16_t * | Value | ||
) |
Read two configuration parameters of a specific digitalSTROM device simultaneously.
Synchronous implementation of DeviceConfig_get.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | |
[in] | ConfigClass | |
[in] | ConfigIndex | |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | Value | Parameter values low byte: ConfigIndex & 0xFE; high byte: ConfigIndex & 0xFE + 1 (only valid if return == 0) |
int DeviceConfig_get_sync_8 | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | ConfigClass, | ||
uint8_t | ConfigIndex, | ||
int | timeout, | ||
uint8_t * | Value | ||
) |
Read a configuration parameter of a specific digitalSTROM device.
Synchronous implementation of DeviceConfig_get.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | |
[in] | ConfigClass | |
[in] | ConfigIndex | |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | Value | Parameter value (only valid if return == 0) |
int DeviceConfig_set | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | ConfigClass, | ||
uint8_t | ConfigIndex, | ||
uint8_t | Value | ||
) |
Write a configuration parameter of a specific digitalSTROM device.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceConfig_set_response_callback_t callback. To receive this request from other bus members register the DeviceConfig_set_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | ConfigClass | Configuration class (Bank). |
[in] | ConfigIndex | Index in class. |
[in] | Value | Parameter value. |
int DeviceGroupMembershipModify_add | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | GroupId | ||
) |
Add the device to this group.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceGroupMembershipModify_add_response_callback_t callback. To receive this request from other bus members register the DeviceGroupMembershipModify_add_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | GroupId | Group ID. |
int DeviceGroupMembershipModify_remove | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | GroupId | ||
) |
remove the device from this group.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceGroupMembershipModify_remove_response_callback_t callback. To receive this request from other bus members register the DeviceGroupMembershipModify_remove_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | GroupId | Group ID. |
int DeviceInfo_by_device_id | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceIdReq, | ||
uint16_t * | DeviceId, | ||
uint16_t * | VendorId, | ||
uint16_t * | ProductId, | ||
uint16_t * | FunctionId, | ||
uint16_t * | Version, | ||
uint16_t * | ZoneId, | ||
uint8_t * | State, | ||
uint8_t * | Locked, | ||
uint8_t * | OutputMode, | ||
uint8_t * | LTMode, | ||
uint8_t * | Groups, | ||
uint8_t * | Name, | ||
uint32_t * | SerialNumber | ||
) |
Returns the properties of a device.
Select the device by device ID.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceInfo_by_device_id_response_callback_t callback. To receive this request from other bus members register the DeviceInfo_by_device_id_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceIdReq | Device ID. |
[out] | DeviceId | Device identifier in the digitalSTROM network. |
[out] | VendorId | Device vendor identification. |
[out] | ProductId | Product identifier. |
[out] | FunctionId | Functionality declaration. |
[out] | Version | Device software version |
[out] | ZoneId | Device is member of this zone. |
[out] | State | 0=Inactive, 1=Active |
[out] | Locked | 0=Not locked, 1=Locked |
[out] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[out] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[out] | Groups | Bitfield of group memberships. 1=Group member (pass a reference to a preallocated buffer of at least 8 bytes.) |
[out] | Name | Device name (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.) |
[out] | SerialNumber | SerialNumber |
int DeviceInfo_by_index | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | ZoneIdReq, | ||
uint16_t | DeviceIndex, | ||
uint16_t * | DeviceId, | ||
uint16_t * | VendorId, | ||
uint16_t * | ProductId, | ||
uint16_t * | FunctionId, | ||
uint16_t * | Version, | ||
uint16_t * | ZoneId, | ||
uint8_t * | State, | ||
uint8_t * | Locked, | ||
uint8_t * | OutputMode, | ||
uint8_t * | LTMode, | ||
uint8_t * | Groups, | ||
uint8_t * | Name, | ||
uint32_t * | SerialNumber | ||
) |
Returns the properties of a device.
Select the device sequentially from all devices of a zone (0 based).
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceInfo_by_index_response_callback_t callback. To receive this request from other bus members register the DeviceInfo_by_index_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | ZoneIdReq | 0 for all zones |
[in] | DeviceIndex | 0 .. ZoneDeviceCount |
[out] | DeviceId | Device identifier in the digitalSTROM network. |
[out] | VendorId | Device vendor identification. |
[out] | ProductId | Product identifier. |
[out] | FunctionId | Functionality declaration. |
[out] | Version | Device software version |
[out] | ZoneId | Device is member of this zone. |
[out] | State | 0=Inactive, 1=Active |
[out] | Locked | 0=Not locked, 1=Locked |
[out] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[out] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[out] | Groups | Bitfield of group memberships. 1=Group member (pass a reference to a preallocated buffer of at least 8 bytes.) |
[out] | Name | Device name (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.) |
[out] | SerialNumber | SerialNumber |
int DeviceInfo_by_index_only_active | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | ZoneIdReq, | ||
uint16_t | DeviceIndex, | ||
uint16_t * | DeviceId, | ||
uint16_t * | VendorId, | ||
uint16_t * | ProductId, | ||
uint16_t * | FunctionId, | ||
uint16_t * | Version, | ||
uint16_t * | ZoneId, | ||
uint8_t * | State, | ||
uint8_t * | Locked, | ||
uint8_t * | OutputMode, | ||
uint8_t * | LTMode, | ||
uint8_t * | Groups, | ||
uint8_t * | Name, | ||
uint32_t * | SerialNumber | ||
) |
Returns the properties of a device.
Select the device sequentially from all active devices of a zone (0 based).
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceInfo_by_index_only_active_response_callback_t callback. To receive this request from other bus members register the DeviceInfo_by_index_only_active_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | ZoneIdReq | 0 for all zones |
[in] | DeviceIndex | 0 .. ZoneDeviceCount |
[out] | DeviceId | Device identifier in the digitalSTROM network. |
[out] | VendorId | Device vendor identification. |
[out] | ProductId | Product identifier. |
[out] | FunctionId | Functionality declaration. |
[out] | Version | Device software version |
[out] | ZoneId | Device is member of this zone. |
[out] | State | 0=Inactive, 1=Active |
[out] | Locked | 0=Not locked, 1=Locked |
[out] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[out] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[out] | Groups | Bitfield of group memberships. 1=Group member (pass a reference to a preallocated buffer of at least 8 bytes.) |
[out] | Name | Device name (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.) |
[out] | SerialNumber | SerialNumber |
int DeviceInfo_by_index_only_inactive | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | ZoneIdReq, | ||
uint16_t | DeviceIndex, | ||
uint16_t * | DeviceId, | ||
uint16_t * | VendorId, | ||
uint16_t * | ProductId, | ||
uint16_t * | FunctionId, | ||
uint16_t * | Version, | ||
uint16_t * | ZoneId, | ||
uint8_t * | State, | ||
uint8_t * | Locked, | ||
uint8_t * | OutputMode, | ||
uint8_t * | LTMode, | ||
uint8_t * | Groups, | ||
uint8_t * | Name, | ||
uint32_t * | SerialNumber | ||
) |
Returns the properties of a device.
Select the device sequentially from all inactive devices of a zone (0 based).
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceInfo_by_index_only_inactive_response_callback_t callback. To receive this request from other bus members register the DeviceInfo_by_index_only_inactive_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | ZoneIdReq | 0 for all zones |
[in] | DeviceIndex | 0 .. ZoneDeviceCount |
[out] | DeviceId | Device identifier in the digitalSTROM network. |
[out] | VendorId | Device vendor identification. |
[out] | ProductId | Product identifier. |
[out] | FunctionId | Functionality declaration. |
[out] | Version | Device software version |
[out] | ZoneId | Device is member of this zone. |
[out] | State | 0=Inactive, 1=Active |
[out] | Locked | 0=Not locked, 1=Locked |
[out] | OutputMode | Cached device MODE register (Class=3, Offset=0). |
[out] | LTMode | Cached device LTMODE register (Class=3, Offset=0x1e) |
[out] | Groups | Bitfield of group memberships. 1=Group member (pass a reference to a preallocated buffer of at least 8 bytes.) |
[out] | Name | Device name (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.) |
[out] | SerialNumber | SerialNumber |
int DeviceProperties_reset_button_active_group | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Reset active group of button to default.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceProperties_reset_button_active_group_response_callback_t callback. To receive this request from other bus members register the DeviceProperties_reset_button_active_group_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int DeviceProperties_set_button_active_group | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | GroupId | ||
) |
Define the active group for the button of the device.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceProperties_set_button_active_group_response_callback_t callback. To receive this request from other bus members register the DeviceProperties_set_button_active_group_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | GroupId | Active group ID for this button (1-63). |
int DeviceProperties_set_button_set_local_priority | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SetLocalPriority | ||
) |
Set if the button triggers the local priority.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceProperties_set_button_set_local_priority_response_callback_t callback. To receive this request from other bus members register the DeviceProperties_set_button_set_local_priority_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | SetLocalPriority | 0=Button does not trigger a SetLocalPriority, 1=Button triggers a SetLocalPriority. |
int DeviceProperties_set_locked_flag | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | LockedFlag | ||
) |
A locked device will not become inactive.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceProperties_set_locked_flag_response_callback_t callback. To receive this request from other bus members register the DeviceProperties_set_locked_flag_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | LockedFlag | 0=not locked, 1=locked. |
int DeviceProperties_set_name | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
const uint8_t * | Name | ||
) |
Set the name of the device.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceProperties_set_name_response_callback_t callback. To receive this request from other bus members register the DeviceProperties_set_name_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | Name | New name of the device (21 character, zero terminated string). |
int DeviceProperties_set_zone | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint16_t | ZoneId | ||
) |
Move the device into a new zone.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceProperties_set_zone_response_callback_t callback. To receive this request from other bus members register the DeviceProperties_set_zone_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | ZoneId | Add device to this zone. |
int DeviceSensor_get_type | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SensorIndex | ||
) |
Access device sensors.
Get the type of sensor SensorIndex. Value is returned with event callback EventDeviceSensor_type_event_callback_t.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceSensor_get_type_response_callback_t callback. To receive this request from other bus members register the DeviceSensor_get_type_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | SensorIndex | Index of the requested sensor on the device. |
int DeviceSensor_get_type_sync | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SensorIndex, | ||
int | timeout, | ||
uint8_t * | SensorPresent, | ||
uint8_t * | SensorType, | ||
uint8_t * | LastSensor | ||
) |
Access device sensors.
Get the type of sensor SensorIndex. Synchronous implementation of DeviceSensor_get_type.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | DeviceId |
[in] | SensorIndex | Index of the requested sensor on the device. |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | SensorPresent | 0=sensor available, 1=no sensor at this index. |
[out] | SensorType | Sensor type |
[out] | LastSensor | 0=Last sensor: no additional sensors at higher indices, 1=additional sensor present. |
int DeviceSensor_get_value | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SensorIndex | ||
) |
Access device sensors.
Get the value of sensor SensorIndex. Value is returned with event callback EventDeviceSensor_value_event_callback_t. DeviceSensor_get_value_sync is a synchronous convenience function with the same functionality.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceSensor_get_value_response_callback_t callback. To receive this request from other bus members register the DeviceSensor_get_value_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | SensorIndex | Index of the requested sensor on the device. |
int DeviceSensor_get_value_sync | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | SensorIndex, | ||
int | timeout, | ||
uint16_t * | SensorValue | ||
) |
Access device sensors.
Get the value of sensor SensorIndex. Synchronous implementation of DeviceSensor_get_value.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | DeviceId |
[in] | SensorIndex | Index of the requested sensor on the device. |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | SensorValue | Current value of the sensor (12 bit). |
int DeviceState | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t * | ActiveFlag | ||
) |
Returns the state of a device.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceState_response_callback_t callback. To receive this request from other bus members register the DeviceState_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[out] | ActiveFlag | 0=inactive, 1=active. |
int DeviceStatisticsRequest_get | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | ParamOffset | ||
) |
Requests statistics data of a device.
Response data is sent with an event (EventDeviceStatistics_event_callback_t). DeviceStatisticsRequest_get_sync is a synchronous convenience function with the same functionality.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the DeviceStatisticsRequest_get_response_callback_t callback. To receive this request from other bus members register the DeviceStatisticsRequest_get_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
[in] | ParamOffset | Index in statistics structure. |
int DeviceStatisticsRequest_get_sync | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
uint8_t | ParamOffset, | ||
int | timeout, | ||
uint16_t * | Value | ||
) |
Requests statistics data of a device.
Synchronous implementation of DeviceStatisticsRequest_get.
ParamOffset 0xFE (Reset) and 0xFF (All values) are not allowed, as they would result in no or multiple response events.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | |
[in] | ParamOffset | |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | Value | Statistics value (only valid if return == 0) |
int TestDevicePresence | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Ping a single device.
Answer is returned with a EventTestDevicePresence_event_callback_t event.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the TestDevicePresence_response_callback_t callback. To receive this request from other bus members register the TestDevicePresence_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int TestTransmissionQuality_get | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId | ||
) |
Query transmission quality.
Answer is returned with a EventTestTransmissionQuality_event_callback_t event. TestTransmissionQuality_get_sync is a synchronous convenience function with the same functionality.
This call has a timeout of 5 seconds.
To receive asynchronous responses to this call (e.g. when addressing broadcast) register the TestTransmissionQuality_get_response_callback_t callback. To receive this request from other bus members register the TestTransmissionQuality_get_request_callback_t callback.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination dSM of the call |
[in] | DeviceId | Device ID. |
int TestTransmissionQuality_get_sync | ( | DsmApiHandle_t | handle, |
dsid_t | dSMdSID, | ||
uint16_t | DeviceId, | ||
int | timeout, | ||
uint8_t * | DownstreamQuality, | ||
uint16_t * | UpstreamQuality | ||
) |
Query transmission quality.
Synchronous implementation of TestTransmissionQuality_get.
[in] | handle | Handle to the library instance |
[in] | dSMdSID | Destination of the call |
[in] | DeviceId | |
[in] | timeout | time-out of the synchronous call (in Seconds) |
[out] | DownstreamQuality | Downstream quality (only valid if return == 0) |
[out] | UpstreamQuality | Upstream quality (only valid if return == 0) |