Debug

This group of API calls addresses debug functionality used in internal development. More...

Typedefs
typedef void(*	dSMDebugMode_disable_jumble_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Disable)
	Disable the Jumble process.
typedef void(*	dSMDebugMode_disable_jumble_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Disable the Jumble process.
typedef void(*	dSMDebugMode_get_communication_log_state_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Get the state of the digitalSTROM communication logging.
typedef void(*	dSMDebugMode_get_communication_log_state_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t State)
	Get the state of the digitalSTROM communication logging.
typedef void(*	dSMDebugMode_get_MMI_flag_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Get the current state of the LED/button test mode.
typedef void(*	dSMDebugMode_get_MMI_flag_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t DebugFlag)
	Get the current state of the LED/button test mode.
typedef void(*	dSMDebugMode_inject_long_upstream_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Source, uint8_t Circuit, uint8_t Mainqualifier, uint8_t Subqualifier, uint32_t Data, uint8_t Quality, uint8_t Flags)
	Test command.
typedef void(*	dSMDebugMode_inject_long_upstream_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Test command.
typedef void(*	dSMDebugMode_inject_short_upstream_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Source, uint8_t Circuit, uint8_t Key, uint8_t Click, uint8_t Sensor, uint8_t Resend, uint8_t Quality, uint8_t Flags)
	Test command.
typedef void(*	dSMDebugMode_inject_short_upstream_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Test command.
typedef void(*	dSMDebugMode_read_flash_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t Index)
	Read raw flash data in 64 byte chunks.
typedef void(*	dSMDebugMode_read_flash_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, const uint8_t *Data)
	Read raw flash data in 64 byte chunks.
typedef void(*	dSMDebugMode_restart_dsp_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Restart the DSP.
typedef void(*	dSMDebugMode_restart_dsp_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Restart the DSP.
typedef void(*	dSMDebugMode_restart_registration_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Invalidate active registration on all devices and restart the device registration.
typedef void(*	dSMDebugMode_restart_registration_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Invalidate active registration on all devices and restart the device registration.
typedef void(*	dSMDebugMode_set_communication_log_state_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t State)
	Set the state of the digitalSTROM communication logging.
typedef void(*	dSMDebugMode_set_communication_log_state_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Set the state of the digitalSTROM communication logging.
typedef void(*	dSMDebugMode_set_MMI_flag_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t DebugFlag)
	Test front LEDs and button.
typedef void(*	dSMDebugMode_set_MMI_flag_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Test front LEDs and button.
typedef void(*	dSMDebugMode_stop_select_b_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Stops all actions on SELECT_B (e.g.
typedef void(*	dSMDebugMode_stop_select_b_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Stops all actions on SELECT_B (e.g.
typedef void(*	dSMDebugMode_write_flash_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t Index, const uint8_t *Data)
	Write raw flash data in 64 byte chunks.
typedef void(*	dSMDebugMode_write_flash_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Write raw flash data in 64 byte chunks.
typedef void(*	EventCommunicationLog_downstream_long_16bit_parameter_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command, uint16_t Data)
	Packet data.
typedef void(*	EventCommunicationLog_downstream_long_8bit_parameter_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command, uint8_t Data)
	Packet data.
typedef void(*	EventCommunicationLog_downstream_long_no_parameter_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command)
	Packet data.
typedef void(*	EventCommunicationLog_downstream_short_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command)
	Packet data.
typedef void(*	EventCommunicationLog_upstream_long_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t CircuitId, uint8_t Mainqualifier, uint8_t Subqualifier, uint32_t Data, uint8_t Quality, uint8_t Flags, uint8_t Crosstalk)
	Packet data.
typedef void(*	EventCommunicationLog_upstream_short_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t CircuitId, uint8_t Resend, uint8_t Sensor, uint8_t Key, uint8_t Click, uint8_t Quality, uint8_t Flags, uint8_t Crosstalk)
	Packet data.
typedef void(*	EventDspDebugData_event_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Length, const uint8_t *Data)
	Debug Data from DSP.
Functions
int	dSMDebugMode_disable_jumble (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t Disable)
	Disable the Jumble process.
int	dSMDebugMode_get_communication_log_state (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t *State)
	Get the state of the digitalSTROM communication logging.
int	dSMDebugMode_get_MMI_flag (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t *DebugFlag)
	Get the current state of the LED/button test mode.
int	dSMDebugMode_inject_long_upstream (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t Source, uint8_t Circuit, uint8_t Mainqualifier, uint8_t Subqualifier, uint32_t Data, uint8_t Quality, uint8_t Flags)
	Test command.
int	dSMDebugMode_inject_short_upstream (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t Source, uint8_t Circuit, uint8_t Key, uint8_t Click, uint8_t Sensor, uint8_t Resend, uint8_t Quality, uint8_t Flags)
	Test command.
int	dSMDebugMode_read_flash (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t Index, uint8_t *Data)
	Read raw flash data in 64 byte chunks.
int	dSMDebugMode_restart_dsp (DsmApiHandle_t handle, dsid_t dSMdSID)
	Restart the DSP.
int	dSMDebugMode_restart_registration (DsmApiHandle_t handle, dsid_t dSMdSID)
	Invalidate active registration on all devices and restart the device registration.
int	dSMDebugMode_set_communication_log_state (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t State)
	Set the state of the digitalSTROM communication logging.
int	dSMDebugMode_set_MMI_flag (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t DebugFlag)
	Test front LEDs and button.
int	dSMDebugMode_stop_select_b (DsmApiHandle_t handle, dsid_t dSMdSID)
	Stops all actions on SELECT_B (e.g.
int	dSMDebugMode_write_flash (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t Index, const uint8_t *Data)
	Write raw flash data in 64 byte chunks.

---

Detailed Description

This group of API calls addresses debug functionality used in internal development.

---

Typedef Documentation

typedef void(* dSMDebugMode_disable_jumble_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Disable)

Disable the Jumble process.

Only single devices can be registered.

Request callback function prototype for call dSMDebugMode_disable_jumble.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_DISABLE_JUMBLE

Parameters:

[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]	Disable	0=Jumble enabled; >0=Jumble disabled

typedef void(* dSMDebugMode_disable_jumble_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Disable the Jumble process.

Only single devices can be registered.

Response callback function prototype for call dSMDebugMode_disable_jumble.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_DISABLE_JUMBLE

Parameters:

[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(* dSMDebugMode_get_communication_log_state_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Get the state of the digitalSTROM communication logging.

0=disabled, 1=enabled.

Request callback function prototype for call dSMDebugMode_get_communication_log_state.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_GET_COMMUNICATION_LOG_STATE

Parameters:

[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(* dSMDebugMode_get_communication_log_state_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t State)

Get the state of the digitalSTROM communication logging.

0=disabled, 1=enabled.

Response callback function prototype for call dSMDebugMode_get_communication_log_state.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_GET_COMMUNICATION_LOG_STATE

Parameters:

[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]	State	Bit 0: Upstream; Bit 1: Downstream

typedef void(* dSMDebugMode_get_MMI_flag_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Get the current state of the LED/button test mode.

Request callback function prototype for call dSMDebugMode_get_MMI_flag.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_GET_MMI_FLAG

Parameters:

[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(* dSMDebugMode_get_MMI_flag_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t DebugFlag)

Get the current state of the LED/button test mode.

Response callback function prototype for call dSMDebugMode_get_MMI_flag.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_GET_MMI_FLAG

Parameters:

[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]	DebugFlag	Flags: Bit 0: LED Blink mode Bit 1: Manual LED test mode on Bit 4: Green LED on Bit 5: Red LED on Bit 6: Blue LED on

typedef void(* dSMDebugMode_inject_long_upstream_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Source, uint8_t Circuit, uint8_t Mainqualifier, uint8_t Subqualifier, uint32_t Data, uint8_t Quality, uint8_t Flags)

Test command.

Inject long upstream message into the dSM to stimulate actions.

Request callback function prototype for call dSMDebugMode_inject_long_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_INJECT_LONG_UPSTREAM

Parameters:

[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]	Source	Source device ID.
[in]	Circuit	Circuit ID.
[in]	Mainqualifier	Message mainqualifier.
[in]	Subqualifier	Message subqualifier.
[in]	Data	Message data. Width depending on mainqualifier.
[in]	Quality	Reception quality [0..62].
[in]	Flags	0=Rx in pos half-wave; 1=Rx in neg half-wave.

typedef void(* dSMDebugMode_inject_long_upstream_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Test command.

Inject long upstream message into the dSM to stimulate actions.

Response callback function prototype for call dSMDebugMode_inject_long_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_INJECT_LONG_UPSTREAM

Parameters:

[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(* dSMDebugMode_inject_short_upstream_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Source, uint8_t Circuit, uint8_t Key, uint8_t Click, uint8_t Sensor, uint8_t Resend, uint8_t Quality, uint8_t Flags)

Test command.

Inject short upstream message into the dSM to stimulate actions.

Request callback function prototype for call dSMDebugMode_inject_short_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_INJECT_SHORT_UPSTREAM

Parameters:

[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]	Source	Source device ID.
[in]	Circuit	Circuit ID.
[in]	Key	Key number
[in]	Click	Click type
[in]	Sensor	Sensor flag. 0=button message, 1=sensor message.
[in]	Resend	Resend flag. 0=message is first, 1=message is repeat.
[in]	Quality	Reception quality [0..62].
[in]	Flags	0=Rx in pos half-wave; 1=Rx in neg half-wave.

typedef void(* dSMDebugMode_inject_short_upstream_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Test command.

Inject short upstream message into the dSM to stimulate actions.

Response callback function prototype for call dSMDebugMode_inject_short_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_INJECT_SHORT_UPSTREAM

Parameters:

[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(* dSMDebugMode_read_flash_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t Index)

Read raw flash data in 64 byte chunks.

Request callback function prototype for call dSMDebugMode_read_flash.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_READ_FLASH

Parameters:

[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]	Index	Chunk index.

typedef void(* dSMDebugMode_read_flash_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, const uint8_t *Data)

Read raw flash data in 64 byte chunks.

Response callback function prototype for call dSMDebugMode_read_flash.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_READ_FLASH

Parameters:

[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]	Data	Flash contents

typedef void(* dSMDebugMode_restart_dsp_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Restart the DSP.

Use to activate a new DSP configuration.

Request callback function prototype for call dSMDebugMode_restart_dsp.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_RESTART_DSP

Parameters:

[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(* dSMDebugMode_restart_dsp_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Restart the DSP.

Use to activate a new DSP configuration.

Response callback function prototype for call dSMDebugMode_restart_dsp.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_RESTART_DSP

Parameters:

[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(* dSMDebugMode_restart_registration_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Invalidate active registration on all devices and restart the device registration.

Request callback function prototype for call dSMDebugMode_restart_registration.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_RESTART_REGISTRATION

Parameters:

[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(* dSMDebugMode_restart_registration_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Invalidate active registration on all devices and restart the device registration.

Response callback function prototype for call dSMDebugMode_restart_registration.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_RESTART_REGISTRATION

Parameters:

[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(* dSMDebugMode_set_communication_log_state_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t State)

Set the state of the digitalSTROM communication logging.

0=disabled, 1=enabled.

Request callback function prototype for call dSMDebugMode_set_communication_log_state.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_SET_COMMUNICATION_LOG_STATE

Parameters:

[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]	State	Bit 0: Upstream; Bit 1: Downstream

typedef void(* dSMDebugMode_set_communication_log_state_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Set the state of the digitalSTROM communication logging.

0=disabled, 1=enabled.

Response callback function prototype for call dSMDebugMode_set_communication_log_state.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_SET_COMMUNICATION_LOG_STATE

Parameters:

[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(* dSMDebugMode_set_MMI_flag_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t DebugFlag)

Test front LEDs and button.

Pressing the front button exits the test mode.

Request callback function prototype for call dSMDebugMode_set_MMI_flag.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_SET_MMI_FLAG

Parameters:

[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]	DebugFlag	Flags: Bit 0: LED Blink mode Bit 1: Manual LED test mode on Bit 4: Green LED on Bit 5: Red LED on Bit 6: Blue LED on

typedef void(* dSMDebugMode_set_MMI_flag_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Test front LEDs and button.

Pressing the front button exits the test mode.

Response callback function prototype for call dSMDebugMode_set_MMI_flag.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_SET_MMI_FLAG

Parameters:

[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(* dSMDebugMode_stop_select_b_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Stops all actions on SELECT_B (e.g.

registration, ping, device properties,...). Reboot dSM to recover functionality.

Request callback function prototype for call dSMDebugMode_stop_select_b.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_STOP_SELECT_B

Parameters:

[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(* dSMDebugMode_stop_select_b_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Stops all actions on SELECT_B (e.g.

registration, ping, device properties,...). Reboot dSM to recover functionality.

Response callback function prototype for call dSMDebugMode_stop_select_b.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_STOP_SELECT_B

Parameters:

[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(* dSMDebugMode_write_flash_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t Index, const uint8_t *Data)

Write raw flash data in 64 byte chunks.

Request callback function prototype for call dSMDebugMode_write_flash.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_WRITE_FLASH

Parameters:

[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]	Index	Chunk index.
[in]	Data	Flash contents

typedef void(* dSMDebugMode_write_flash_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Write raw flash data in 64 byte chunks.

Response callback function prototype for call dSMDebugMode_write_flash.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_DEBUG_MODE and ModifierId = DSM_DEBUG_MODE_WRITE_FLASH

Parameters:

[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(* EventCommunicationLog_downstream_long_16bit_parameter_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command, uint16_t Data)

Packet data.

Contains the information of a long downstream message with a 16-bit parameter.

Event callback function prototype.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_COMMUNICATION_LOG and ModifierId = EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_16BIT_PARAMETER

Parameters:

[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]	Command	Message command.
[in]	Data	Parameter data.

typedef void(* EventCommunicationLog_downstream_long_8bit_parameter_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command, uint8_t Data)

Packet data.

Contains the information of a long downstream message with a 8-bit parameter.

Event callback function prototype.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_COMMUNICATION_LOG and ModifierId = EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_8BIT_PARAMETER

Parameters:

[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]	Command	Message command.
[in]	Data	Parameter data.

typedef void(* EventCommunicationLog_downstream_long_no_parameter_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command)

Packet data.

Contains the information of a long downstream message with no parameter.

Event callback function prototype.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_COMMUNICATION_LOG and ModifierId = EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_NO_PARAMETER

Parameters:

[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]	Command	Message command.

typedef void(* EventCommunicationLog_downstream_short_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Command)

Packet data.

Contains the information of a short downstream message.

Event callback function prototype.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_COMMUNICATION_LOG and ModifierId = EVENT_COMMUNICATION_LOG_DOWNSTREAM_SHORT

Parameters:

[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]	Command	Message content.

typedef void(* EventCommunicationLog_upstream_long_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t CircuitId, uint8_t Mainqualifier, uint8_t Subqualifier, uint32_t Data, uint8_t Quality, uint8_t Flags, uint8_t Crosstalk)

Packet data.

Contains the information of a long upstream message.

Event callback function prototype.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_COMMUNICATION_LOG and ModifierId = EVENT_COMMUNICATION_LOG_UPSTREAM_LONG

Parameters:

[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 of the sending device.
[in]	CircuitId	CircuitId
[in]	Mainqualifier
[in]	Subqualifier
[in]	Data	Payload data.
[in]	Quality	Reception quality [0..64].
[in]	Flags	0=Rx in pos half-wave; 1=Rx in neg half-wave.
[in]	Crosstalk	0=packet was accepted, 1=packet was crosstalk.

typedef void(* EventCommunicationLog_upstream_short_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t DeviceId, uint8_t CircuitId, uint8_t Resend, uint8_t Sensor, uint8_t Key, uint8_t Click, uint8_t Quality, uint8_t Flags, uint8_t Crosstalk)

Packet data.

Contains the information of a short upstream message.

Event callback function prototype.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_COMMUNICATION_LOG and ModifierId = EVENT_COMMUNICATION_LOG_UPSTREAM_SHORT

Parameters:

[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 of the sending device.
[in]	CircuitId	CircuitId
[in]	Resend	1=Resend
[in]	Sensor	0=Button; 1=Sensor
[in]	Key	Button number.
[in]	Click	Click type.
[in]	Quality	Reception quality [0..64].
[in]	Flags	0=Rx in pos half-wave; 1=Rx in neg half-wave.
[in]	Crosstalk	0=packet was accepted, 1=packet was crosstalk.

typedef void(* EventDspDebugData_event_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Length, const uint8_t *Data)

Debug Data from DSP.

Event callback function prototype.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_EVENT, MessageId = EVENT_DSP_DEBUG_DATA and ModifierId = #0

Parameters:

[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]	Length
[in]	Data

---

Function Documentation

int dSMDebugMode_disable_jumble	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	Disable
	)

Disable the Jumble process.

Only single devices can be registered.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_disable_jumble_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_disable_jumble_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Disable	0=Jumble enabled; >0=Jumble disabled

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_get_communication_log_state	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	State
	)

Get the state of the digitalSTROM communication logging.

0=disabled, 1=enabled.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_get_communication_log_state_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_get_communication_log_state_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	State	Bit 0: Upstream; Bit 1: Downstream

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_get_MMI_flag	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	DebugFlag
	)

Get the current state of the LED/button test mode.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_get_MMI_flag_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_get_MMI_flag_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	DebugFlag	Flags: Bit 0: LED Blink mode Bit 1: Manual LED test mode on Bit 4: Green LED on Bit 5: Red LED on Bit 6: Blue LED on

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_inject_long_upstream	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	Source,
		uint8_t	Circuit,
		uint8_t	Mainqualifier,
		uint8_t	Subqualifier,
		uint32_t	Data,
		uint8_t	Quality,
		uint8_t	Flags
	)

Test command.

Inject long upstream message into the dSM to stimulate actions.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_inject_long_upstream_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_inject_long_upstream_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Source	Source device ID.
[in]	Circuit	Circuit ID.
[in]	Mainqualifier	Message mainqualifier.
[in]	Subqualifier	Message subqualifier.
[in]	Data	Message data. Width depending on mainqualifier.
[in]	Quality	Reception quality [0..62].
[in]	Flags	0=Rx in pos half-wave; 1=Rx in neg half-wave.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_inject_short_upstream	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	Source,
		uint8_t	Circuit,
		uint8_t	Key,
		uint8_t	Click,
		uint8_t	Sensor,
		uint8_t	Resend,
		uint8_t	Quality,
		uint8_t	Flags
	)

Test command.

Inject short upstream message into the dSM to stimulate actions.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_inject_short_upstream_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_inject_short_upstream_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Source	Source device ID.
[in]	Circuit	Circuit ID.
[in]	Key	Key number
[in]	Click	Click type
[in]	Sensor	Sensor flag. 0=button message, 1=sensor message.
[in]	Resend	Resend flag. 0=message is first, 1=message is repeat.
[in]	Quality	Reception quality [0..62].
[in]	Flags	0=Rx in pos half-wave; 1=Rx in neg half-wave.

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_read_flash	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t	Index,
		uint8_t *	Data
	)

Read raw flash data in 64 byte chunks.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_read_flash_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_read_flash_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Index	Chunk index.
[out]	Data	Flash contents (pass a reference to a preallocated buffer of at least 64 bytes.)

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_restart_dsp	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Restart the DSP.

Use to activate a new DSP configuration.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_restart_dsp_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_restart_dsp_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_restart_registration	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Invalidate active registration on all devices and restart the device registration.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_restart_registration_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_restart_registration_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_set_communication_log_state	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	State
	)

Set the state of the digitalSTROM communication logging.

0=disabled, 1=enabled.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_set_communication_log_state_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_set_communication_log_state_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	State	Bit 0: Upstream; Bit 1: Downstream

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_set_MMI_flag	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	DebugFlag
	)

Test front LEDs and button.

Pressing the front button exits the test mode.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_set_MMI_flag_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_set_MMI_flag_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	DebugFlag	Flags: Bit 0: LED Blink mode Bit 1: Manual LED test mode on Bit 4: Green LED on Bit 5: Red LED on Bit 6: Blue LED on

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_stop_select_b	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Stops all actions on SELECT_B (e.g.

registration, ping, device properties,...). Reboot dSM to recover functionality.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_stop_select_b_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_stop_select_b_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code

int dSMDebugMode_write_flash	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t	Index,
		const uint8_t *	Data
	)

Write raw flash data in 64 byte chunks.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMDebugMode_write_flash_response_callback_t callback. To receive this request from other bus members register the dSMDebugMode_write_flash_request_callback_t callback.

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Index	Chunk index.
[in]	Data	Flash contents

Returns:

0: success (return parameters are valid); <0: Library error; >0: dSM error code