This group of API calls addresses information and settings of the dSM itself. More...

Typedefs
typedef void(*	dSMConfig_get_DSP_config_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Read DSP configuration as byte stream.
typedef void(*	dSMConfig_get_DSP_config_response_callback_t )(uint8_t error_code, void arg, dsid_t sourceId, dsid_t destinationId, uint8_t Size, const uint8_t Config)
	Read DSP configuration as byte stream.
typedef void(*	dSMConfig_get_hash_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Get a hash of the whole dSM datamodel.
typedef void(*	dSMConfig_get_hash_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t Hash, uint32_t ConfigurationCount)
	Get a hash of the whole dSM datamodel.
typedef void(*	dSMConfig_set_dSM_config_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, dsid_t DSID, uint32_t HWVersion)
	Set dSMdSID and Hardware version.
typedef void(*	dSMConfig_set_dSM_config_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Set dSMdSID and Hardware version.
typedef void(*	dSMConfig_set_DSP_config_request_callback_t )(uint8_t error_code, void arg, dsid_t sourceId, dsid_t destinationId, uint8_t Size, const uint8_t Config)
	Program DSP configuration as byte stream.
typedef void(*	dSMConfig_set_DSP_config_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Program DSP configuration as byte stream.
typedef void(*	dSMFactoryReset_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Password)
	Removes all user specific data form the dSM.
typedef void(*	dSMFactoryReset_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Removes all user specific data form the dSM.
typedef void(*	dSMInfo_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Returns the properties of the dSM.
typedef void(*	dSMInfo_response_callback_t )(uint8_t error_code, void arg, dsid_t sourceId, dsid_t destinationId, uint32_t HWVersion, uint32_t ARMSWVersion, uint32_t DSPSWVersion, uint16_t ApiVersion, dsid_t DSID, const uint8_t Name)
	Returns the properties of the dSM.
typedef void(*	dSMProperties_get_apartment_id_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_apartment_id_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ApartmentId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_current_temperature_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_current_temperature_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Temperature)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_flags_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_flags_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Flags)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_max_temperature_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_max_temperature_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t MaxTemperature)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_ping_intervals_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_ping_intervals_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t AutoPingInterval, uint16_t OnePingInterval)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_power_down_duration_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_power_down_duration_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Duration)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_temperature_limits_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_temperature_limits_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t WarnTemperature, uint8_t ErrorTemperature)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_upstream_frequency_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_get_upstream_frequency_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t UpstreamFrequency)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_reset_max_temperature_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_reset_max_temperature_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_apartment_id_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t ApartmentId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_apartment_id_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_flags_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Flags)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_flags_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_name_request_callback_t )(uint8_t error_code, void arg, dsid_t sourceId, dsid_t destinationId, const uint8_t Name)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_name_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_ping_intervals_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t AutoPingInterval, uint16_t OnePingInterval)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_ping_intervals_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_temperature_limits_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t WarnTemperature, uint8_t ErrorTemperature)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_temperature_limits_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_upstream_frequency_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t UpstreamFrequency)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMProperties_set_upstream_frequency_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Change persistent configuration settings of the dSM.
typedef void(*	dSMReboot_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reboots the dSM.
typedef void(*	dSMReboot_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reboots the dSM.
typedef void(*	dSMState_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Returns the current operation state as indicated with the front LEDs.
typedef void(*	dSMState_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Hardware, uint8_t DSP, uint8_t Temperature, uint8_t Config, uint8_t dS485, uint8_t Line)
	Returns the current operation state as indicated with the front LEDs.
typedef void(*	dSMStatistics_get_dS485_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Returns dS485 communications statistics.
typedef void(*	dSMStatistics_get_dS485_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t TxToken, uint16_t TxStartupRequest, uint16_t TxStartupResponse, uint16_t TxJoinRequest, uint16_t TxJoinResponse, uint16_t TxGetAddressRequest, uint16_t TxGetAddressResponse, uint16_t TxSetAddressRequest, uint16_t TxSetAddressResponse, uint16_t TxSetSuccessorAddressRequest, uint16_t TxSetSuccessorAddressResponse, uint16_t TxResponse, uint16_t TxDataRequest, uint16_t TxDataResponse, uint16_t TxDataEvent, uint16_t RxResponse, uint16_t RxDataRequest, uint16_t RxDataResponse, uint16_t RxDataEvent, uint16_t StartRegisterStation, uint16_t DoneRegisterStation, uint16_t EnterOperational, uint16_t SuccessorLost)
	Returns dS485 communications statistics.
typedef void(*	dSMStatistics_get_internals_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Get the current internal debug statistics.
typedef void(*	dSMStatistics_get_internals_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t RxShortUpstream, uint32_t RxLongUpstream, uint32_t TxDownstream, uint32_t TxErrorSelectA, uint32_t TxErrorSelectB, uint32_t DSPResets, uint32_t DSPMsgSizeError, uint32_t DSPMsgMagicError, uint32_t DSPMsgUnknown)
	Get the current internal debug statistics.
typedef void(*	dSMStatistics_get_pool_margins_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Get the pool/event queue margins.
typedef void(*	dSMStatistics_get_pool_margins_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t SmallPoolMargin, uint8_t MediumPoolMargin, uint8_t LargePoolMargin, uint8_t FreescaleQueueMargin, uint8_t MMIQueueMargin, uint8_t dSMAPIQueueMargin, uint8_t DatamodelQueueMargin, uint8_t SelectBQueueMargin, uint8_t SelectAQueueMargin, uint8_t SPIQueueMargin, uint8_t dS485QueueMargin, uint8_t ReceiverQueueMargin, uint8_t dSMAPIDeferredQueue, uint8_t dS485TxMessageQueue, uint8_t dS485DeferredTxMessageQueue, uint8_t FreescaleDeferredQueue, uint8_t MMIDeferredQueue, uint8_t SelectADeferredQueue, uint8_t SelectBDeferredCommandQueue, uint8_t SelectBDeferredDsidQueue, uint8_t SPIFrontPanelDeferredQueue, uint8_t SPIPrioDeferredQueue, uint8_t SPIDSPTxMessageQueue)
	Get the pool/event queue margins.
typedef void(*	dSMStatistics_get_stop_timer_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Index)
	Get information about a specific STOP timer.
typedef void(*	dSMStatistics_get_stop_timer_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t TimerActive, uint8_t LocalZoneId, uint8_t GroupId, uint8_t ButtonId, uint8_t TimeOut, uint8_t RefCount, uint32_t TimerCount)
	Get information about a specific STOP timer.
typedef void(*	dSMStatistics_get_upstream_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Index)
	Retrieve the current statistics of the Upstream receiver.
typedef void(*	dSMStatistics_get_upstream_response_callback_t )(uint8_t error_code, void arg, dsid_t sourceId, dsid_t destinationId, uint8_t Length, const uint8_t Statistics)
	Retrieve the current statistics of the Upstream receiver.
typedef void(*	dSMStatistics_reset_dS485_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reset dS485 communications statistics.
typedef void(*	dSMStatistics_reset_dS485_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reset dS485 communications statistics.
typedef void(*	dSMStatistics_reset_internals_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reset the internal debug statistics.
typedef void(*	dSMStatistics_reset_internals_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reset the internal debug statistics.
typedef void(*	dSMStatistics_reset_upstream_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reset the statistics of the Upstream receiver.
typedef void(*	dSMStatistics_reset_upstream_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Reset the statistics of the Upstream receiver.
typedef void(*	ImageMaintenance_check_image_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Check the validity of the stored image file.
typedef void(*	ImageMaintenance_check_image_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ReadCRC, uint16_t ComputedCRC)
	Check the validity of the stored image file.
typedef void(*	ImageMaintenance_get_image_info_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Get file information of the stored image file.
typedef void(*	ImageMaintenance_get_image_info_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t ManufacturerId, uint32_t DeviceId, uint32_t ContentType, uint32_t ContentSize, uint16_t ContentCRC)
	Get file information of the stored image file.
typedef void(*	ImageMaintenance_remove_image_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Remove the stored image file from Flash.
typedef void(*	ImageMaintenance_remove_image_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Remove the stored image file from Flash.
typedef void(*	ImageMaintenance_start_update_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Start update process.
typedef void(*	ImageMaintenance_start_update_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Start update process.
typedef void(*	ImageTransfer_data_request_callback_t )(uint8_t error_code, void arg, dsid_t sourceId, dsid_t destinationId, uint32_t PacketNr, const uint8_t Data)
	Write a new Image to the Flash of the dSM.
typedef void(*	ImageTransfer_data_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t ExpectedPacketNr, uint32_t ReceivedPacketNr)
	Write a new Image to the Flash of the dSM.
typedef void(*	ImageTransfer_write_request_request_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t ManufacturerId, uint32_t DeviceId, uint32_t ContentType, uint32_t ContentSize, uint16_t ContentCRC)
	Write a new Image to the Flash of the dSM.
typedef void(*	ImageTransfer_write_request_response_callback_t )(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)
	Write a new Image to the Flash of the dSM.
Functions
int	dSMConfig_get_DSP_config (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t Size, uint8_t Config)
	Read DSP configuration as byte stream.
int	dSMConfig_get_hash (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t Hash, uint32_t ConfigurationCount)
	Get a hash of the whole dSM datamodel.
int	dSMConfig_set_dSM_config (DsmApiHandle_t handle, dsid_t dSMdSID, dsid_t DSID, uint32_t HWVersion)
	Set dSMdSID and Hardware version.
int	dSMConfig_set_DSP_config (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t Size, const uint8_t *Config)
	Program DSP configuration as byte stream.
int	dSMFactoryReset (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t Password)
	Removes all user specific data form the dSM.
int	dSMInfo (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t HWVersion, uint32_t ARMSWVersion, uint32_t DSPSWVersion, uint16_t ApiVersion, dsid_t DSID, uint8_t Name)
	Returns the properties of the dSM.
int	dSMProperties_get_apartment_id (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t *ApartmentId)
	Change persistent configuration settings of the dSM.
int	dSMProperties_get_current_temperature (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t *Temperature)
	Change persistent configuration settings of the dSM.
int	dSMProperties_get_flags (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t *Flags)
	Change persistent configuration settings of the dSM.
int	dSMProperties_get_max_temperature (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t *MaxTemperature)
	Change persistent configuration settings of the dSM.
int	dSMProperties_get_ping_intervals (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t AutoPingInterval, uint16_t OnePingInterval)
	Change persistent configuration settings of the dSM.
int	dSMProperties_get_power_down_duration (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t *Duration)
	Change persistent configuration settings of the dSM.
int	dSMProperties_get_temperature_limits (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t WarnTemperature, uint8_t ErrorTemperature)
	Change persistent configuration settings of the dSM.
int	dSMProperties_get_upstream_frequency (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t *UpstreamFrequency)
	Change persistent configuration settings of the dSM.
int	dSMProperties_reset_max_temperature (DsmApiHandle_t handle, dsid_t dSMdSID)
	Change persistent configuration settings of the dSM.
int	dSMProperties_set_apartment_id (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t ApartmentId)
	Change persistent configuration settings of the dSM.
int	dSMProperties_set_flags (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t Flags)
	Change persistent configuration settings of the dSM.
int	dSMProperties_set_name (DsmApiHandle_t handle, dsid_t dSMdSID, const uint8_t *Name)
	Change persistent configuration settings of the dSM.
int	dSMProperties_set_ping_intervals (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t AutoPingInterval, uint16_t OnePingInterval)
	Change persistent configuration settings of the dSM.
int	dSMProperties_set_temperature_limits (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t WarnTemperature, uint8_t ErrorTemperature)
	Change persistent configuration settings of the dSM.
int	dSMProperties_set_upstream_frequency (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t UpstreamFrequency)
	Change persistent configuration settings of the dSM.
int	dSMReboot (DsmApiHandle_t handle, dsid_t dSMdSID)
	Reboots the dSM.
int	dSMState (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t Hardware, uint8_t DSP, uint8_t Temperature, uint8_t Config, uint8_t dS485, uint8_t Line)
	Returns the current operation state as indicated with the front LEDs.
int	dSMStatistics_get_dS485 (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t TxToken, uint16_t TxStartupRequest, uint16_t TxStartupResponse, uint16_t TxJoinRequest, uint16_t TxJoinResponse, uint16_t TxGetAddressRequest, uint16_t TxGetAddressResponse, uint16_t TxSetAddressRequest, uint16_t TxSetAddressResponse, uint16_t TxSetSuccessorAddressRequest, uint16_t TxSetSuccessorAddressResponse, uint16_t TxResponse, uint16_t TxDataRequest, uint16_t TxDataResponse, uint16_t TxDataEvent, uint16_t RxResponse, uint16_t RxDataRequest, uint16_t RxDataResponse, uint16_t RxDataEvent, uint16_t StartRegisterStation, uint16_t DoneRegisterStation, uint16_t EnterOperational, uint16_t *SuccessorLost)
	Returns dS485 communications statistics.
int	dSMStatistics_get_internals (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t RxShortUpstream, uint32_t RxLongUpstream, uint32_t TxDownstream, uint32_t TxErrorSelectA, uint32_t TxErrorSelectB, uint32_t DSPResets, uint32_t DSPMsgSizeError, uint32_t DSPMsgMagicError, uint32_t *DSPMsgUnknown)
	Get the current internal debug statistics.
int	dSMStatistics_get_pool_margins (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t SmallPoolMargin, uint8_t MediumPoolMargin, uint8_t LargePoolMargin, uint8_t FreescaleQueueMargin, uint8_t MMIQueueMargin, uint8_t dSMAPIQueueMargin, uint8_t DatamodelQueueMargin, uint8_t SelectBQueueMargin, uint8_t SelectAQueueMargin, uint8_t SPIQueueMargin, uint8_t dS485QueueMargin, uint8_t ReceiverQueueMargin, uint8_t dSMAPIDeferredQueue, uint8_t dS485TxMessageQueue, uint8_t dS485DeferredTxMessageQueue, uint8_t FreescaleDeferredQueue, uint8_t MMIDeferredQueue, uint8_t SelectADeferredQueue, uint8_t SelectBDeferredCommandQueue, uint8_t SelectBDeferredDsidQueue, uint8_t SPIFrontPanelDeferredQueue, uint8_t SPIPrioDeferredQueue, uint8_t *SPIDSPTxMessageQueue)
	Get the pool/event queue margins.
int	dSMStatistics_get_stop_timer (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t Index, uint8_t TimerActive, uint8_t LocalZoneId, uint8_t GroupId, uint8_t ButtonId, uint8_t TimeOut, uint8_t RefCount, uint32_t *TimerCount)
	Get information about a specific STOP timer.
int	dSMStatistics_get_upstream (DsmApiHandle_t handle, dsid_t dSMdSID, uint8_t Index, uint8_t Length, uint8_t Statistics)
	Retrieve the current statistics of the Upstream receiver.
int	dSMStatistics_reset_dS485 (DsmApiHandle_t handle, dsid_t dSMdSID)
	Reset dS485 communications statistics.
int	dSMStatistics_reset_internals (DsmApiHandle_t handle, dsid_t dSMdSID)
	Reset the internal debug statistics.
int	dSMStatistics_reset_upstream (DsmApiHandle_t handle, dsid_t dSMdSID)
	Reset the statistics of the Upstream receiver.
int	ImageMaintenance_check_image (DsmApiHandle_t handle, dsid_t dSMdSID, uint16_t ReadCRC, uint16_t ComputedCRC)
	Check the validity of the stored image file.
int	ImageMaintenance_get_image_info (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t ManufacturerId, uint32_t DeviceId, uint32_t ContentType, uint32_t ContentSize, uint16_t *ContentCRC)
	Get file information of the stored image file.
int	ImageMaintenance_remove_image (DsmApiHandle_t handle, dsid_t dSMdSID)
	Remove the stored image file from Flash.
int	ImageMaintenance_start_update (DsmApiHandle_t handle, dsid_t dSMdSID)
	Start update process.
int	ImageTransfer_data (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t PacketNr, const uint8_t Data, uint32_t ExpectedPacketNr, uint32_t *ReceivedPacketNr)
	Write a new Image to the Flash of the dSM.
int	ImageTransfer_write_request (DsmApiHandle_t handle, dsid_t dSMdSID, uint32_t ManufacturerId, uint32_t DeviceId, uint32_t ContentType, uint32_t ContentSize, uint16_t ContentCRC)
	Write a new Image to the Flash of the dSM.

Detailed Description

This group of API calls addresses information and settings of the dSM itself.

Typedef Documentation

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

Read DSP configuration as byte stream.

Request callback function prototype for call dSMConfig_get_DSP_config.

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

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(* dSMConfig_get_DSP_config_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Size, const uint8_t *Config)

Read DSP configuration as byte stream.

Response callback function prototype for call dSMConfig_get_DSP_config.

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

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]	Size	Size of the data in bytes.
[in]	Config	Configuration data.

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

Get a hash of the whole dSM datamodel.

The Hash is recalculated on every dSM start-up. If there are any configuration changes durin operation the ConfigurationCount is incremented.

Request callback function prototype for call dSMConfig_get_hash.

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

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(* dSMConfig_get_hash_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t Hash, uint32_t ConfigurationCount)

Get a hash of the whole dSM datamodel.

The Hash is recalculated on every dSM start-up. If there are any configuration changes durin operation the ConfigurationCount is incremented.

Response callback function prototype for call dSMConfig_get_hash.

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

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]	Hash	Datamodel Hash at start-up.
[in]	ConfigurationCount	Incremented on every datamodel change during run-time.

typedef void(* dSMConfig_set_dSM_config_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, dsid_t DSID, uint32_t HWVersion)

Set dSMdSID and Hardware version.

Request callback function prototype for call dSMConfig_set_dSM_config.

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

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]	DSID	dSM unique digitalSTROM ID.
[in]	HWVersion	Hardware version

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

Set dSMdSID and Hardware version.

Response callback function prototype for call dSMConfig_set_dSM_config.

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

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(* dSMConfig_set_DSP_config_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Size, const uint8_t *Config)

Program DSP configuration as byte stream.

Becomes active after a dSMReboot or dSMDebugMode_restart_dsp.

Request callback function prototype for call dSMConfig_set_DSP_config.

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

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]	Size	Size of the data in bytes.
[in]	Config	Configuration data.

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

Program DSP configuration as byte stream.

Becomes active after a dSMReboot or dSMDebugMode_restart_dsp.

Response callback function prototype for call dSMConfig_set_DSP_config.

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

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(* dSMFactoryReset_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Password)

Removes all user specific data form the dSM.

After that, the dSM reboots. This operation takes around 1 minute to complete. During this time no actions are possible.

Request callback function prototype for call dSMFactoryReset.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_FACTORY_RESET 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]	Password	cafeh

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

Removes all user specific data form the dSM.

After that, the dSM reboots. This operation takes around 1 minute to complete. During this time no actions are possible.

Response callback function prototype for call dSMFactoryReset.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_FACTORY_RESET 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

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

Returns the properties of the dSM.

Request callback function prototype for call dSMInfo.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_INFO 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

typedef void(* dSMInfo_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t HWVersion, uint32_t ARMSWVersion, uint32_t DSPSWVersion, uint16_t ApiVersion, dsid_t DSID, const uint8_t *Name)

Returns the properties of the dSM.

Response callback function prototype for call dSMInfo.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_INFO 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]	HWVersion	Hardware version
[in]	ARMSWVersion	ARM Software version
[in]	DSPSWVersion	DSP Software version
[in]	ApiVersion	dSM-API version
[in]	DSID	dSID
[in]	Name	Name (21 character, zero terminated string).

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured apartment ID.

Request callback function prototype for call dSMProperties_get_apartment_id.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured apartment ID.

Response callback function prototype for call dSMProperties_get_apartment_id.

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

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]	ApartmentId	Apartment ID.

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured temperature.

Request callback function prototype for call dSMProperties_get_current_temperature.

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

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(* dSMProperties_get_current_temperature_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t Temperature)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured temperature.

Response callback function prototype for call dSMProperties_get_current_temperature.

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

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]	Temperature	dSM internal temperature [Degree Celcius]

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get persistent dSM configuration flags.

Bit 0: Show 'Green' in ready state.
Bit 2-1: Default ping behavior: 0: no ping, 1: auto (continuous) ping, 2: one-time ping, 3: 24h ping mode
Bit 3: Programming mode disabled.

Request callback function prototype for call dSMProperties_get_flags.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get persistent dSM configuration flags.

Bit 0: Show 'Green' in ready state.
Bit 2-1: Default ping behavior: 0: no ping, 1: auto (continuous) ping, 2: one-time ping, 3: 24h ping mode
Bit 3: Programming mode disabled.

Response callback function prototype for call dSMProperties_get_flags.

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

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]	Flags	Bitfield of flags. 1=Flag set, 0=Flag cleared

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the stored max temperature.

Request callback function prototype for call dSMProperties_get_max_temperature.

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

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(* dSMProperties_get_max_temperature_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t MaxTemperature)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the stored max temperature.

Response callback function prototype for call dSMProperties_get_max_temperature.

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

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]	MaxTemperature	Highest measured temperature.

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the default pinging intervals.

Request callback function prototype for call dSMProperties_get_ping_intervals.

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

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(* dSMProperties_get_ping_intervals_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t AutoPingInterval, uint16_t OnePingInterval)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the default pinging intervals.

Response callback function prototype for call dSMProperties_get_ping_intervals.

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

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]	AutoPingInterval	Time between ping commands in automatic (continuous) mode [milliseconds].
[in]	OnePingInterval	Time between ping commands in one-time rounds [milliseconds].

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the last estimated power-down duration.

Request callback function prototype for call dSMProperties_get_power_down_duration.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the last estimated power-down duration.

Response callback function prototype for call dSMProperties_get_power_down_duration.

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

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]	Duration	0=short, 1=long

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured temperature limits.

Request callback function prototype for call dSMProperties_get_temperature_limits.

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

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(* dSMProperties_get_temperature_limits_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t WarnTemperature, uint8_t ErrorTemperature)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured temperature limits.

Response callback function prototype for call dSMProperties_get_temperature_limits.

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

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]	WarnTemperature	Temperature-Warning level. dSM stops transmitting downstream upon reaching this level.
[in]	ErrorTemperature	Temperature-Error level. dSM halts. A power cycle is needed for recovery.

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get used upstream frequency

Request callback function prototype for call dSMProperties_get_upstream_frequency.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get used upstream frequency

Response callback function prototype for call dSMProperties_get_upstream_frequency.

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

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]	UpstreamFrequency	0: 15/20 kHz; 1: 12/20 kHz; 2: 10/15 kHz; 3: 10/12 kHz

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Reset the stored max temperature.

Request callback function prototype for call dSMProperties_reset_max_temperature.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Reset the stored max temperature.

Response callback function prototype for call dSMProperties_reset_max_temperature.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the apartment ID.

Request callback function prototype for call dSMProperties_set_apartment_id.

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

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]	ApartmentId	Apartment ID.

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the apartment ID.

Response callback function prototype for call dSMProperties_set_apartment_id.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set persistent dSM configuration flags.

Bit 0: Show 'Green' in ready state.
Bit 2-1: Default ping behavior: 0: no ping, 1: auto (continuous) ping, 2: one-time ping, 3: 24h ping mode
Bit 3: Programming mode disabled.

Request callback function prototype for call dSMProperties_set_flags.

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

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]	Flags	Bitfield of flags. 1=Set flag, 0=Clear Flag

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set persistent dSM configuration flags.

Bit 0: Show 'Green' in ready state.
Bit 2-1: Default ping behavior: 0: no ping, 1: auto (continuous) ping, 2: one-time ping, 3: 24h ping mode
Bit 3: Programming mode disabled.

Response callback function prototype for call dSMProperties_set_flags.

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

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(* dSMProperties_set_name_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, const uint8_t *Name)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the name.

Request callback function prototype for call dSMProperties_set_name.

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

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]	Name	The new name of the dSM (21 character, zero terminated string).

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the name.

Response callback function prototype for call dSMProperties_set_name.

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

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(* dSMProperties_set_ping_intervals_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t AutoPingInterval, uint16_t OnePingInterval)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the default pinging intervals.

Request callback function prototype for call dSMProperties_set_ping_intervals.

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

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]	AutoPingInterval	Time between ping commands in automatic (continuous) mode [milliseconds].
[in]	OnePingInterval	Time between ping commands in one-time rounds [milliseconds].

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the default pinging intervals.

Response callback function prototype for call dSMProperties_set_ping_intervals.

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

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(* dSMProperties_set_temperature_limits_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t WarnTemperature, uint8_t ErrorTemperature)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the temperature limits.

Request callback function prototype for call dSMProperties_set_temperature_limits.

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

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]	WarnTemperature	Temperature-Warning level. dSM stops transmitting downstream upon reaching this level.
[in]	ErrorTemperature	Temperature-Error level. dSM halts. A power cycle is needed for recovery.

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the temperature limits.

Response callback function prototype for call dSMProperties_set_temperature_limits.

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

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set used upstream frequency. Changing this property will result in a DSP restart for reconfiguration.

Request callback function prototype for call dSMProperties_set_upstream_frequency.

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

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]	UpstreamFrequency	0: 15/20 kHz; 1: 12/20 kHz; 2: 10/15 kHz; 3: 10/12 kHz

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

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set used upstream frequency. Changing this property will result in a DSP restart for reconfiguration.

Response callback function prototype for call dSMProperties_set_upstream_frequency.

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

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

Reboots the dSM.

Request callback function prototype for call dSMReboot.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_REBOOT 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

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

Reboots the dSM.

Response callback function prototype for call dSMReboot.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_REBOOT 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

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

Returns the current operation state as indicated with the front LEDs.

Request callback function prototype for call dSMState.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_STATE 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

typedef void(* dSMState_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Hardware, uint8_t DSP, uint8_t Temperature, uint8_t Config, uint8_t dS485, uint8_t Line)

Returns the current operation state as indicated with the front LEDs.

Response callback function prototype for call dSMState.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_STATE 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]	Hardware	0=Ok, 1=Updating, 2=Failure
[in]	DSP	0=Ready, 1=Not Ready
[in]	Temperature	0=OK, 1=over warn level, 2=over error level
[in]	Config	0=Ok, 1=Invalid
[in]	dS485	0=Ready, 1=Initializing
[in]	Line	0=Idle, 1=Jumbling (registration)

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

Returns dS485 communications statistics.

Request callback function prototype for call dSMStatistics_get_dS485.

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

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(* dSMStatistics_get_dS485_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t TxToken, uint16_t TxStartupRequest, uint16_t TxStartupResponse, uint16_t TxJoinRequest, uint16_t TxJoinResponse, uint16_t TxGetAddressRequest, uint16_t TxGetAddressResponse, uint16_t TxSetAddressRequest, uint16_t TxSetAddressResponse, uint16_t TxSetSuccessorAddressRequest, uint16_t TxSetSuccessorAddressResponse, uint16_t TxResponse, uint16_t TxDataRequest, uint16_t TxDataResponse, uint16_t TxDataEvent, uint16_t RxResponse, uint16_t RxDataRequest, uint16_t RxDataResponse, uint16_t RxDataEvent, uint16_t StartRegisterStation, uint16_t DoneRegisterStation, uint16_t EnterOperational, uint16_t SuccessorLost)

Returns dS485 communications statistics.

Response callback function prototype for call dSMStatistics_get_dS485.

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

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]	TxToken
[in]	TxStartupRequest
[in]	TxStartupResponse
[in]	TxJoinRequest
[in]	TxJoinResponse
[in]	TxGetAddressRequest
[in]	TxGetAddressResponse
[in]	TxSetAddressRequest
[in]	TxSetAddressResponse
[in]	TxSetSuccessorAddressRequest
[in]	TxSetSuccessorAddressResponse
[in]	TxResponse
[in]	TxDataRequest
[in]	TxDataResponse
[in]	TxDataEvent
[in]	RxResponse
[in]	RxDataRequest
[in]	RxDataResponse
[in]	RxDataEvent
[in]	StartRegisterStation
[in]	DoneRegisterStation
[in]	EnterOperational
[in]	SuccessorLost

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

Get the current internal debug statistics.

Request callback function prototype for call dSMStatistics_get_internals.

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

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(* dSMStatistics_get_internals_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t RxShortUpstream, uint32_t RxLongUpstream, uint32_t TxDownstream, uint32_t TxErrorSelectA, uint32_t TxErrorSelectB, uint32_t DSPResets, uint32_t DSPMsgSizeError, uint32_t DSPMsgMagicError, uint32_t DSPMsgUnknown)

Get the current internal debug statistics.

Response callback function prototype for call dSMStatistics_get_internals.

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

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]	RxShortUpstream	Number of received short Upstream messages.
[in]	RxLongUpstream	Number of received long Upstream messages.
[in]	TxDownstream	Number of transmitted Downstream messages.
[in]	TxErrorSelectA	Number of queue overflows in the high-priority Downstream queue (SelectA).
[in]	TxErrorSelectB	Number of queue overflows in the low-priority Downstream queue (SelectB).
[in]	DSPResets	Number of DSP Resets.
[in]	DSPMsgSizeError	Number wrongly sized messages.
[in]	DSPMsgMagicError	Number of messages with wrong magic.
[in]	DSPMsgUnknown	Number of unknown messages.

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

Get the pool/event queue margins.

Request callback function prototype for call dSMStatistics_get_pool_margins.

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

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(* dSMStatistics_get_pool_margins_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t SmallPoolMargin, uint8_t MediumPoolMargin, uint8_t LargePoolMargin, uint8_t FreescaleQueueMargin, uint8_t MMIQueueMargin, uint8_t dSMAPIQueueMargin, uint8_t DatamodelQueueMargin, uint8_t SelectBQueueMargin, uint8_t SelectAQueueMargin, uint8_t SPIQueueMargin, uint8_t dS485QueueMargin, uint8_t ReceiverQueueMargin, uint8_t dSMAPIDeferredQueue, uint8_t dS485TxMessageQueue, uint8_t dS485DeferredTxMessageQueue, uint8_t FreescaleDeferredQueue, uint8_t MMIDeferredQueue, uint8_t SelectADeferredQueue, uint8_t SelectBDeferredCommandQueue, uint8_t SelectBDeferredDsidQueue, uint8_t SPIFrontPanelDeferredQueue, uint8_t SPIPrioDeferredQueue, uint8_t SPIDSPTxMessageQueue)

Get the pool/event queue margins.

Response callback function prototype for call dSMStatistics_get_pool_margins.

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

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]	SmallPoolMargin	Min number of free queue spots.
[in]	MediumPoolMargin	Min number of free queue spots.
[in]	LargePoolMargin	Min number of free queue spots.
[in]	FreescaleQueueMargin	Min number of free queue spots.
[in]	MMIQueueMargin	Min number of free queue spots.
[in]	dSMAPIQueueMargin	Min number of free queue spots.
[in]	DatamodelQueueMargin	Min number of free queue spots.
[in]	SelectBQueueMargin	Min number of free queue spots.
[in]	SelectAQueueMargin	Min number of free queue spots.
[in]	SPIQueueMargin	Min number of free queue spots.
[in]	dS485QueueMargin	Min number of free queue spots.
[in]	ReceiverQueueMargin	Min number of free queue spots.
[in]	dSMAPIDeferredQueue	Min number of free queue spots.
[in]	dS485TxMessageQueue	Min number of free queue spots.
[in]	dS485DeferredTxMessageQueue	Min number of free queue spots.
[in]	FreescaleDeferredQueue	Min number of free queue spots.
[in]	MMIDeferredQueue	Min number of free queue spots.
[in]	SelectADeferredQueue	Min number of free queue spots.
[in]	SelectBDeferredCommandQueue	Min number of free queue spots.
[in]	SelectBDeferredDsidQueue	Min number of free queue spots.
[in]	SPIFrontPanelDeferredQueue	Min number of free queue spots.
[in]	SPIPrioDeferredQueue	Min number of free queue spots.
[in]	SPIDSPTxMessageQueue	Min number of free queue spots.

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

Get information about a specific STOP timer.

Request callback function prototype for call dSMStatistics_get_stop_timer.

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

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	Timer Index.

typedef void(* dSMStatistics_get_stop_timer_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t TimerActive, uint8_t LocalZoneId, uint8_t GroupId, uint8_t ButtonId, uint8_t TimeOut, uint8_t RefCount, uint32_t TimerCount)

Get information about a specific STOP timer.

Response callback function prototype for call dSMStatistics_get_stop_timer.

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

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]	TimerActive	0=timer inacctive, 1=timer running.
[in]	LocalZoneId
[in]	GroupId
[in]	ButtonId
[in]	TimeOut	in Seconds
[in]	RefCount
[in]	TimerCount

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

Retrieve the current statistics of the Upstream receiver.

The statistics data is transferred in 96 bytes chunks selected by Index. Only Index==0 updates the statistics. Other Indices just transfer previously fetched data.

Request callback function prototype for call dSMStatistics_get_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_STATISTICS and ModifierId = DSM_STATISTICS_GET_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]	Index	Requested index into statistics structure

typedef void(* dSMStatistics_get_upstream_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint8_t Length, const uint8_t *Statistics)

Retrieve the current statistics of the Upstream receiver.

The statistics data is transferred in 96 bytes chunks selected by Index. Only Index==0 updates the statistics. Other Indices just transfer previously fetched data.

Response callback function prototype for call dSMStatistics_get_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_STATISTICS and ModifierId = DSM_STATISTICS_GET_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]	Length	Length of data in buffer
[in]	Statistics	Statistics as a byte array.

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

Reset dS485 communications statistics.

Request callback function prototype for call dSMStatistics_reset_dS485.

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

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

Reset dS485 communications statistics.

Response callback function prototype for call dSMStatistics_reset_dS485.

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

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

Reset the internal debug statistics.

Request callback function prototype for call dSMStatistics_reset_internals.

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

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

Reset the internal debug statistics.

Response callback function prototype for call dSMStatistics_reset_internals.

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

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

Reset the statistics of the Upstream receiver.

Request callback function prototype for call dSMStatistics_reset_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_REQUEST, MessageId = DSM_STATISTICS and ModifierId = DSM_STATISTICS_RESET_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(* dSMStatistics_reset_upstream_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Reset the statistics of the Upstream receiver.

Response callback function prototype for call dSMStatistics_reset_upstream.

To register this callback function, call the DsmApiSetCallback function with MessageType = DS485_CONTAINER_RESPONSE, MessageId = DSM_STATISTICS and ModifierId = DSM_STATISTICS_RESET_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(* ImageMaintenance_check_image_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId)

Check the validity of the stored image file.

Request callback function prototype for call ImageMaintenance_check_image.

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

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(* ImageMaintenance_check_image_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint16_t ReadCRC, uint16_t ComputedCRC)

Check the validity of the stored image file.

Response callback function prototype for call ImageMaintenance_check_image.

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

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]	ReadCRC
[in]	ComputedCRC

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

Get file information of the stored image file.

Request callback function prototype for call ImageMaintenance_get_image_info.

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

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(* ImageMaintenance_get_image_info_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t ManufacturerId, uint32_t DeviceId, uint32_t ContentType, uint32_t ContentSize, uint16_t ContentCRC)

Get file information of the stored image file.

Response callback function prototype for call ImageMaintenance_get_image_info.

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

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]	ManufacturerId
[in]	DeviceId
[in]	ContentType
[in]	ContentSize
[in]	ContentCRC

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

Remove the stored image file from Flash.

Request callback function prototype for call ImageMaintenance_remove_image.

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

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

Remove the stored image file from Flash.

Response callback function prototype for call ImageMaintenance_remove_image.

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

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

Start update process.

Request callback function prototype for call ImageMaintenance_start_update.

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

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

Start update process.

Response callback function prototype for call ImageMaintenance_start_update.

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

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

Write a new Image to the Flash of the dSM.

The transfer of a image needs several calls. The protocol is the following. First, a write request has to be done. If successful, data packets are sent. Each packet is numbered. The packets must be transferred with consecutive, increasing numbers. The dSM knows, when the last packet is transferred. A transfer can't be canceled, but if a new transfer is started unless the old one is finished, the old one is implicit canceled. Further steps, like burning, have to be done with the command Image Maintenance. ATTENTION: The user has to ensure, that only one transfer is active at once. If a second transfer is started until the first finished, the behavior is undefined. Since the transfer is nothing special, the dSM is processing other calls between data calls. Transfer image data.

Request callback function prototype for call ImageTransfer_data.

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

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]	PacketNr	Current packet number.
[in]	Data	it's only for the last packet allowed to have less than 64 data bytes.

typedef void(* ImageTransfer_data_response_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t ExpectedPacketNr, uint32_t ReceivedPacketNr)

Write a new Image to the Flash of the dSM.

The transfer of a image needs several calls. The protocol is the following. First, a write request has to be done. If successful, data packets are sent. Each packet is numbered. The packets must be transferred with consecutive, increasing numbers. The dSM knows, when the last packet is transferred. A transfer can't be canceled, but if a new transfer is started unless the old one is finished, the old one is implicit canceled. Further steps, like burning, have to be done with the command Image Maintenance. ATTENTION: The user has to ensure, that only one transfer is active at once. If a second transfer is started until the first finished, the behavior is undefined. Since the transfer is nothing special, the dSM is processing other calls between data calls. Transfer image data.

Response callback function prototype for call ImageTransfer_data.

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

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]	ExpectedPacketNr	dSM expected this packet.
[in]	ReceivedPacketNr	dSM received this packet.

typedef void(* ImageTransfer_write_request_request_callback_t)(uint8_t error_code, void *arg, dsid_t sourceId, dsid_t destinationId, uint32_t ManufacturerId, uint32_t DeviceId, uint32_t ContentType, uint32_t ContentSize, uint16_t ContentCRC)

Write a new Image to the Flash of the dSM.

The transfer of a image needs several calls. The protocol is the following. First, a write request has to be done. If successful, data packets are sent. Each packet is numbered. The packets must be transferred with consecutive, increasing numbers. The dSM knows, when the last packet is transferred. A transfer can't be canceled, but if a new transfer is started unless the old one is finished, the old one is implicit canceled. Further steps, like burning, have to be done with the command Image Maintenance. ATTENTION: The user has to ensure, that only one transfer is active at once. If a second transfer is started until the first finished, the behavior is undefined. Since the transfer is nothing special, the dSM is processing other calls between data calls. Start the image transfer.

Request callback function prototype for call ImageTransfer_write_request.

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

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]	ManufacturerId
[in]	DeviceId
[in]	ContentType
[in]	ContentSize
[in]	ContentCRC

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

Write a new Image to the Flash of the dSM.

The transfer of a image needs several calls. The protocol is the following. First, a write request has to be done. If successful, data packets are sent. Each packet is numbered. The packets must be transferred with consecutive, increasing numbers. The dSM knows, when the last packet is transferred. A transfer can't be canceled, but if a new transfer is started unless the old one is finished, the old one is implicit canceled. Further steps, like burning, have to be done with the command Image Maintenance. ATTENTION: The user has to ensure, that only one transfer is active at once. If a second transfer is started until the first finished, the behavior is undefined. Since the transfer is nothing special, the dSM is processing other calls between data calls. Start the image transfer.

Response callback function prototype for call ImageTransfer_write_request.

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

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

Function Documentation

int dSMConfig_get_DSP_config	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	Size,
		uint8_t *	Config
	)

Read DSP configuration as byte stream.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	Size	Size of the data in bytes.
[out]	Config	Configuration data. (pass a reference to a preallocated buffer of at least 96 bytes.)

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

int dSMConfig_get_hash	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t *	Hash,
		uint32_t *	ConfigurationCount
	)

Get a hash of the whole dSM datamodel.

The Hash is recalculated on every dSM start-up. If there are any configuration changes durin operation the ConfigurationCount is incremented.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	Hash	Datamodel Hash at start-up.
[out]	ConfigurationCount	Incremented on every datamodel change during run-time.

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

int dSMConfig_set_dSM_config	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		dsid_t	DSID,
		uint32_t	HWVersion
	)

Set dSMdSID and Hardware version.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	DSID	dSM unique digitalSTROM ID.
[in]	HWVersion	Hardware version

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

int dSMConfig_set_DSP_config	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	Size,
		const uint8_t *	Config
	)

Program DSP configuration as byte stream.

Becomes active after a dSMReboot or dSMDebugMode_restart_dsp.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Size	Size of the data in bytes.
[in]	Config	Configuration data.

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

int dSMFactoryReset	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	Password
	)

Removes all user specific data form the dSM.

After that, the dSM reboots. This operation takes around 1 minute to complete. During this time no actions are possible.

This call has a timeout of 5 seconds.

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

Parameters:

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

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

int dSMInfo	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t *	HWVersion,
		uint32_t *	ARMSWVersion,
		uint32_t *	DSPSWVersion,
		uint16_t *	ApiVersion,
		dsid_t *	DSID,
		uint8_t *	Name
	)

Returns the properties of the dSM.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	HWVersion	Hardware version
[out]	ARMSWVersion	ARM Software version
[out]	DSPSWVersion	DSP Software version
[out]	ApiVersion	dSM-API version
[out]	DSID	dSID (pass a reference to a preallocated buffer of at least 12 bytes.)
[out]	Name	Name (21 character, zero terminated string). (pass a reference to a preallocated buffer of at least 21 bytes.)

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

int dSMProperties_get_apartment_id	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	ApartmentId
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured apartment ID.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	ApartmentId	Apartment ID.

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

int dSMProperties_get_current_temperature	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t *	Temperature
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured temperature.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	Temperature	dSM internal temperature [Degree Celcius]

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

int dSMProperties_get_flags	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	Flags
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get persistent dSM configuration flags.

Bit 0: Show 'Green' in ready state.
Bit 2-1: Default ping behavior: 0: no ping, 1: auto (continuous) ping, 2: one-time ping, 3: 24h ping mode
Bit 3: Programming mode disabled.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	Flags	Bitfield of flags. 1=Flag set, 0=Flag cleared

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

int dSMProperties_get_max_temperature	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t *	MaxTemperature
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the stored max temperature.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	MaxTemperature	Highest measured temperature.

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

int dSMProperties_get_ping_intervals	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t *	AutoPingInterval,
		uint16_t *	OnePingInterval
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the default pinging intervals.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	AutoPingInterval	Time between ping commands in automatic (continuous) mode [milliseconds].
[out]	OnePingInterval	Time between ping commands in one-time rounds [milliseconds].

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

int dSMProperties_get_power_down_duration	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	Duration
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the last estimated power-down duration.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	Duration	0=short, 1=long

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

int dSMProperties_get_temperature_limits	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	WarnTemperature,
		uint8_t *	ErrorTemperature
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get the configured temperature limits.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	WarnTemperature	Temperature-Warning level. dSM stops transmitting downstream upon reaching this level.
[out]	ErrorTemperature	Temperature-Error level. dSM halts. A power cycle is needed for recovery.

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

int dSMProperties_get_upstream_frequency	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	UpstreamFrequency
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Get used upstream frequency

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	UpstreamFrequency	0: 15/20 kHz; 1: 12/20 kHz; 2: 10/15 kHz; 3: 10/12 kHz

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

int dSMProperties_reset_max_temperature	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Reset the stored max temperature.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMProperties_reset_max_temperature_response_callback_t callback. To receive this request from other bus members register the dSMProperties_reset_max_temperature_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 dSMProperties_set_apartment_id	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	ApartmentId
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the apartment ID.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ApartmentId	Apartment ID.

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

int dSMProperties_set_flags	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	Flags
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set persistent dSM configuration flags.

Bit 0: Show 'Green' in ready state.
Bit 2-1: Default ping behavior: 0: no ping, 1: auto (continuous) ping, 2: one-time ping, 3: 24h ping mode
Bit 3: Programming mode disabled.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Flags	Bitfield of flags. 1=Set flag, 0=Clear Flag

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

int dSMProperties_set_name	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		const uint8_t *	Name
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the name.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Name	The new name of the dSM (21 character, zero terminated string).

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

int dSMProperties_set_ping_intervals	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t	AutoPingInterval,
		uint16_t	OnePingInterval
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the default pinging intervals.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	AutoPingInterval	Time between ping commands in automatic (continuous) mode [milliseconds].
[in]	OnePingInterval	Time between ping commands in one-time rounds [milliseconds].

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

int dSMProperties_set_temperature_limits	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	WarnTemperature,
		uint8_t	ErrorTemperature
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set the temperature limits.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	WarnTemperature	Temperature-Warning level. dSM stops transmitting downstream upon reaching this level.
[in]	ErrorTemperature	Temperature-Error level. dSM halts. A power cycle is needed for recovery.

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

int dSMProperties_set_upstream_frequency	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	UpstreamFrequency
	)

Change persistent configuration settings of the dSM.

Any changes are only active after a dSM reboot. Set used upstream frequency. Changing this property will result in a DSP restart for reconfiguration.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	UpstreamFrequency	0: 15/20 kHz; 1: 12/20 kHz; 2: 10/15 kHz; 3: 10/12 kHz

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

int dSMReboot	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Reboots the dSM.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMReboot_response_callback_t callback. To receive this request from other bus members register the dSMReboot_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 dSMState	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	Hardware,
		uint8_t *	DSP,
		uint8_t *	Temperature,
		uint8_t *	Config,
		uint8_t *	dS485,
		uint8_t *	Line
	)

Returns the current operation state as indicated with the front LEDs.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	Hardware	0=Ok, 1=Updating, 2=Failure
[out]	DSP	0=Ready, 1=Not Ready
[out]	Temperature	0=OK, 1=over warn level, 2=over error level
[out]	Config	0=Ok, 1=Invalid
[out]	dS485	0=Ready, 1=Initializing
[out]	Line	0=Idle, 1=Jumbling (registration)

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

int dSMStatistics_get_dS485	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t *	TxToken,
		uint16_t *	TxStartupRequest,
		uint16_t *	TxStartupResponse,
		uint16_t *	TxJoinRequest,
		uint16_t *	TxJoinResponse,
		uint16_t *	TxGetAddressRequest,
		uint16_t *	TxGetAddressResponse,
		uint16_t *	TxSetAddressRequest,
		uint16_t *	TxSetAddressResponse,
		uint16_t *	TxSetSuccessorAddressRequest,
		uint16_t *	TxSetSuccessorAddressResponse,
		uint16_t *	TxResponse,
		uint16_t *	TxDataRequest,
		uint16_t *	TxDataResponse,
		uint16_t *	TxDataEvent,
		uint16_t *	RxResponse,
		uint16_t *	RxDataRequest,
		uint16_t *	RxDataResponse,
		uint16_t *	RxDataEvent,
		uint16_t *	StartRegisterStation,
		uint16_t *	DoneRegisterStation,
		uint16_t *	EnterOperational,
		uint16_t *	SuccessorLost
	)

Returns dS485 communications statistics.

This call has a timeout of 10 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	TxToken
[out]	TxStartupRequest
[out]	TxStartupResponse
[out]	TxJoinRequest
[out]	TxJoinResponse
[out]	TxGetAddressRequest
[out]	TxGetAddressResponse
[out]	TxSetAddressRequest
[out]	TxSetAddressResponse
[out]	TxSetSuccessorAddressRequest
[out]	TxSetSuccessorAddressResponse
[out]	TxResponse
[out]	TxDataRequest
[out]	TxDataResponse
[out]	TxDataEvent
[out]	RxResponse
[out]	RxDataRequest
[out]	RxDataResponse
[out]	RxDataEvent
[out]	StartRegisterStation
[out]	DoneRegisterStation
[out]	EnterOperational
[out]	SuccessorLost

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

int dSMStatistics_get_internals	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t *	RxShortUpstream,
		uint32_t *	RxLongUpstream,
		uint32_t *	TxDownstream,
		uint32_t *	TxErrorSelectA,
		uint32_t *	TxErrorSelectB,
		uint32_t *	DSPResets,
		uint32_t *	DSPMsgSizeError,
		uint32_t *	DSPMsgMagicError,
		uint32_t *	DSPMsgUnknown
	)

Get the current internal debug statistics.

This call has a timeout of 10 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	RxShortUpstream	Number of received short Upstream messages.
[out]	RxLongUpstream	Number of received long Upstream messages.
[out]	TxDownstream	Number of transmitted Downstream messages.
[out]	TxErrorSelectA	Number of queue overflows in the high-priority Downstream queue (SelectA).
[out]	TxErrorSelectB	Number of queue overflows in the low-priority Downstream queue (SelectB).
[out]	DSPResets	Number of DSP Resets.
[out]	DSPMsgSizeError	Number wrongly sized messages.
[out]	DSPMsgMagicError	Number of messages with wrong magic.
[out]	DSPMsgUnknown	Number of unknown messages.

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

int dSMStatistics_get_pool_margins	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t *	SmallPoolMargin,
		uint8_t *	MediumPoolMargin,
		uint8_t *	LargePoolMargin,
		uint8_t *	FreescaleQueueMargin,
		uint8_t *	MMIQueueMargin,
		uint8_t *	dSMAPIQueueMargin,
		uint8_t *	DatamodelQueueMargin,
		uint8_t *	SelectBQueueMargin,
		uint8_t *	SelectAQueueMargin,
		uint8_t *	SPIQueueMargin,
		uint8_t *	dS485QueueMargin,
		uint8_t *	ReceiverQueueMargin,
		uint8_t *	dSMAPIDeferredQueue,
		uint8_t *	dS485TxMessageQueue,
		uint8_t *	dS485DeferredTxMessageQueue,
		uint8_t *	FreescaleDeferredQueue,
		uint8_t *	MMIDeferredQueue,
		uint8_t *	SelectADeferredQueue,
		uint8_t *	SelectBDeferredCommandQueue,
		uint8_t *	SelectBDeferredDsidQueue,
		uint8_t *	SPIFrontPanelDeferredQueue,
		uint8_t *	SPIPrioDeferredQueue,
		uint8_t *	SPIDSPTxMessageQueue
	)

Get the pool/event queue margins.

This call has a timeout of 10 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	SmallPoolMargin	Min number of free queue spots.
[out]	MediumPoolMargin	Min number of free queue spots.
[out]	LargePoolMargin	Min number of free queue spots.
[out]	FreescaleQueueMargin	Min number of free queue spots.
[out]	MMIQueueMargin	Min number of free queue spots.
[out]	dSMAPIQueueMargin	Min number of free queue spots.
[out]	DatamodelQueueMargin	Min number of free queue spots.
[out]	SelectBQueueMargin	Min number of free queue spots.
[out]	SelectAQueueMargin	Min number of free queue spots.
[out]	SPIQueueMargin	Min number of free queue spots.
[out]	dS485QueueMargin	Min number of free queue spots.
[out]	ReceiverQueueMargin	Min number of free queue spots.
[out]	dSMAPIDeferredQueue	Min number of free queue spots.
[out]	dS485TxMessageQueue	Min number of free queue spots.
[out]	dS485DeferredTxMessageQueue	Min number of free queue spots.
[out]	FreescaleDeferredQueue	Min number of free queue spots.
[out]	MMIDeferredQueue	Min number of free queue spots.
[out]	SelectADeferredQueue	Min number of free queue spots.
[out]	SelectBDeferredCommandQueue	Min number of free queue spots.
[out]	SelectBDeferredDsidQueue	Min number of free queue spots.
[out]	SPIFrontPanelDeferredQueue	Min number of free queue spots.
[out]	SPIPrioDeferredQueue	Min number of free queue spots.
[out]	SPIDSPTxMessageQueue	Min number of free queue spots.

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

int dSMStatistics_get_stop_timer	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	Index,
		uint8_t *	TimerActive,
		uint8_t *	LocalZoneId,
		uint8_t *	GroupId,
		uint8_t *	ButtonId,
		uint8_t *	TimeOut,
		uint8_t *	RefCount,
		uint32_t *	TimerCount
	)

Get information about a specific STOP timer.

This call has a timeout of 10 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Index	Timer Index.
[out]	TimerActive	0=timer inacctive, 1=timer running.
[out]	LocalZoneId
[out]	GroupId
[out]	ButtonId
[out]	TimeOut	in Seconds
[out]	RefCount
[out]	TimerCount

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

int dSMStatistics_get_upstream	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint8_t	Index,
		uint8_t *	Length,
		uint8_t *	Statistics
	)

Retrieve the current statistics of the Upstream receiver.

The statistics data is transferred in 96 bytes chunks selected by Index. Only Index==0 updates the statistics. Other Indices just transfer previously fetched data.

This call has a timeout of 10 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	Index	Requested index into statistics structure
[out]	Length	Length of data in buffer
[out]	Statistics	Statistics as a byte array. (pass a reference to a preallocated buffer of at least 96 bytes.)

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

int dSMStatistics_reset_dS485	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Reset dS485 communications statistics.

This call has a timeout of 10 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMStatistics_reset_dS485_response_callback_t callback. To receive this request from other bus members register the dSMStatistics_reset_dS485_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 dSMStatistics_reset_internals	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Reset the internal debug statistics.

This call has a timeout of 10 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMStatistics_reset_internals_response_callback_t callback. To receive this request from other bus members register the dSMStatistics_reset_internals_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 dSMStatistics_reset_upstream	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Reset the statistics of the Upstream receiver.

This call has a timeout of 10 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the dSMStatistics_reset_upstream_response_callback_t callback. To receive this request from other bus members register the dSMStatistics_reset_upstream_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 ImageMaintenance_check_image	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint16_t *	ReadCRC,
		uint16_t *	ComputedCRC
	)

Check the validity of the stored image file.

This call has a timeout of 5 seconds.

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

Parameters:

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

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

int ImageMaintenance_get_image_info	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t *	ManufacturerId,
		uint32_t *	DeviceId,
		uint32_t *	ContentType,
		uint32_t *	ContentSize,
		uint16_t *	ContentCRC
	)

Get file information of the stored image file.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[out]	ManufacturerId
[out]	DeviceId
[out]	ContentType
[out]	ContentSize
[out]	ContentCRC

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

int ImageMaintenance_remove_image	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Remove the stored image file from Flash.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ImageMaintenance_remove_image_response_callback_t callback. To receive this request from other bus members register the ImageMaintenance_remove_image_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 ImageMaintenance_start_update	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID
	)

Start update process.

This call has a timeout of 5 seconds.

To receive asynchronous responses to this call (e.g. when addressing broadcast) register the ImageMaintenance_start_update_response_callback_t callback. To receive this request from other bus members register the ImageMaintenance_start_update_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 ImageTransfer_data	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t	PacketNr,
		const uint8_t *	Data,
		uint32_t *	ExpectedPacketNr,
		uint32_t *	ReceivedPacketNr
	)

Write a new Image to the Flash of the dSM.

The transfer of a image needs several calls. The protocol is the following. First, a write request has to be done. If successful, data packets are sent. Each packet is numbered. The packets must be transferred with consecutive, increasing numbers. The dSM knows, when the last packet is transferred. A transfer can't be canceled, but if a new transfer is started unless the old one is finished, the old one is implicit canceled. Further steps, like burning, have to be done with the command Image Maintenance. ATTENTION: The user has to ensure, that only one transfer is active at once. If a second transfer is started until the first finished, the behavior is undefined. Since the transfer is nothing special, the dSM is processing other calls between data calls. Transfer image data.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	PacketNr	Current packet number.
[in]	Data	it's only for the last packet allowed to have less than 64 data bytes.
[out]	ExpectedPacketNr	dSM expected this packet.
[out]	ReceivedPacketNr	dSM received this packet.

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

int ImageTransfer_write_request	(	DsmApiHandle_t	handle,
		dsid_t	dSMdSID,
		uint32_t	ManufacturerId,
		uint32_t	DeviceId,
		uint32_t	ContentType,
		uint32_t	ContentSize,
		uint16_t	ContentCRC
	)

Write a new Image to the Flash of the dSM.

The transfer of a image needs several calls. The protocol is the following. First, a write request has to be done. If successful, data packets are sent. Each packet is numbered. The packets must be transferred with consecutive, increasing numbers. The dSM knows, when the last packet is transferred. A transfer can't be canceled, but if a new transfer is started unless the old one is finished, the old one is implicit canceled. Further steps, like burning, have to be done with the command Image Maintenance. ATTENTION: The user has to ensure, that only one transfer is active at once. If a second transfer is started until the first finished, the behavior is undefined. Since the transfer is nothing special, the dSM is processing other calls between data calls. Start the image transfer.

This call has a timeout of 5 seconds.

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

Parameters:

[in]	handle	Handle to the library instance
[in]	dSMdSID	Destination dSM of the call
[in]	ManufacturerId
[in]	DeviceId
[in]	ContentType
[in]	ContentSize
[in]	ContentCRC

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

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation