Implementation for the ServiceAccessPoint DeviceManagement. More...

#include <SAP/WiMOD_SAP_DEVMGMT.h>

Inheritance diagram for WiMOD_SAP_DevMgmt:

[legend]

Public Member Functions
	WiMOD_SAP_DevMgmt (TWiMODLRHCI hci, UINT8 buffer, UINT16 bufferSize)
	Constructor. More...

virtual	~WiMOD_SAP_DevMgmt (void)
	Destructor.

virtual TWiMODLRResultCodes	Ping (UINT8 *statusRsp)
	Ping Cmd - Checks if the serial connection of to the WiMOD module is OK. More...

virtual TWiMODLRResultCodes	Reset (UINT8 *statusRsp)
	Reset Cmd - Do a reset / reboot of the WiMOD. More...

virtual TWiMODLRResultCodes	GetDeviceInfo (TWiMODLR_DevMgmt_DevInfo info, UINT8 statusRsp)
	Get Device Info - Basic Information about the WiMOD module. More...

virtual TWiMODLRResultCodes	GetFirmwareInfo (TWiMODLR_DevMgmt_FwInfo info, UINT8 statusRsp)
	GetFirmwareInfo Cmd - Get basic info about the running firmware. More...

virtual TWiMODLRResultCodes	GetSystemStatus (TWiMODLR_DevMgmt_SystemStatus info, UINT8 statusRsp)
	GetSystemStatus Cmd - Get basic info about the system status of WiMOD. More...

virtual TWiMODLRResultCodes	GetRtc (UINT32 rtcTime, UINT8 statusRsp)
	GetRtc Cmd - Get the current RTC time/date from WiMOD. More...

virtual TWiMODLRResultCodes	SetRtc (const UINT32 rtcTime, UINT8 *statusRsp)
	SetRtc Cmd - Set the current RTC time/date of WiMOD. More...

virtual TWiMODLRResultCodes	GetRadioConfig (TWiMODLR_DevMgmt_RadioConfig radioCfg, UINT8 statusRsp)
	GetRadioConfig Cmd - Get the radio settings of the WiMOD. More...

virtual TWiMODLRResultCodes	SetRadioConfig (const TWiMODLR_DevMgmt_RadioConfig radioCfg, UINT8 statusRsp)
	SetRadioConfig Cmd - Set the radio settings of the WiMOD. More...

virtual TWiMODLRResultCodes	ResetRadioConfig (UINT8 *statusRsp)
	ResetRadioConfig Cmd - Reset the radio config to factory defaults. More...

virtual TWiMODLRResultCodes	GetOperationMode (TWiMOD_OperationMode opMode, UINT8 statusRsp)
	GetOperationMode Cmd - Get the current operation mode of the WiMOD. More...

virtual TWiMODLRResultCodes	SetOperationMode (const TWiMOD_OperationMode opMode, UINT8 *statusRsp)
	SetOperationMode Cmd - Set the current operation mode of the WiMOD. More...

virtual TWiMODLRResultCodes	SetRadioMode (const TRadioCfg_RadioMode radioMode, UINT8 *statusRsp)
	SetRadioMode - Set the current radio mode of the WiMOD. More...

virtual TWiMODLRResultCodes	SetAesKey (const UINT8 key, UINT8 statusRsp)
	SetAesKey Cmd - Set the 128bit AES that is to be used for encryption. More...

virtual TWiMODLRResultCodes	GetAesKey (UINT8 key, UINT8 statusRsp)
	GetAesKey Cmd - Get the 128bit AES that that is used for encryption. More...

virtual TWiMODLRResultCodes	SetRtcAlarm (const TWiMODLR_DevMgmt_RtcAlarm rtcAlarm, UINT8 statusRsp)
	SetRtcAlarm Cmd - Set a new RTC alarm config. More...

virtual TWiMODLRResultCodes	GetRtcAlarm (TWiMODLR_DevMgmt_RtcAlarm rtcAlarm, UINT8 statusRsp)
	GetRtcAlarm Cmd - Get information about RTC alarm feature. More...

virtual TWiMODLRResultCodes	ClearRtcAlarm (UINT8 *statusRsp)
	ClearRtcAlarm Cmd - Clear a pending RTC alarm. More...

virtual TWiMODLRResultCodes	SetHCIConfig (TWiMODLR_DevMgmt_HciConfig &hciConfig, UINT8 *statusRsp)
	SetHCIConfig Cmd - Sets the HCI config options for the LR-BASE_PLUS firmware. More...

virtual TWiMODLRResultCodes	GetHCIConfig (TWiMODLR_DevMgmt_HciConfig hciConfig, UINT8 statusRsp)
	SetHCIConfig Cmd - Gets the HCI config options for the LR-BASE_PLUS firmware. More...

void	RegisterPowerUpIndicationClient (TDevMgmtPowerUpCallback cb)
	Register a callback function for processing a PowerUp Indication message. More...

void	RegisterRtcAlarmIndicationClient (TDevMgmtRtcAlarmCallback cb)
	Register a callback function for processing a RTC Alarm Indication message. More...

void	DispatchDeviceMgmtMessage (TWiMODLR_HCIMessage &rxMsg)

Detailed Description

Implementation for the ServiceAccessPoint DeviceManagement.

Constructor & Destructor Documentation

◆ WiMOD_SAP_DevMgmt()

WiMOD_SAP_DevMgmt::WiMOD_SAP_DevMgmt	(	TWiMODLRHCI *	hci,
		UINT8 *	buffer,
		UINT16	bufferSize
	)

Constructor.

Parameters

hci	Pointer to HCI processor object
buffer	pointer to storage area for building tx frames; MUST BE VALID
bufferSize	size of the buffer

Member Function Documentation

◆ ClearRtcAlarm()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::ClearRtcAlarm ( UINT8 * statusRsp )

virtual

ClearRtcAlarm Cmd - Clear a pending RTC alarm.

Parameters

statusRsp pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ GetAesKey()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetAesKey	(	UINT8 *	key,
		UINT8 *	statusRsp
	)

virtual

GetAesKey Cmd - Get the 128bit AES that that is used for encryption.

Parameters

key	pointer where to store the 128bit AES key (pointer to array of 16 UINT8 entries)
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_Lorawan.

◆ GetDeviceInfo()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetDeviceInfo	(	TWiMODLR_DevMgmt_DevInfo *	info,
		UINT8 *	statusRsp
	)

virtual

Get Device Info - Basic Information about the WiMOD module.

Parameters

info	pointer to store the received information
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_Lorawan.

◆ GetFirmwareInfo()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetFirmwareInfo	(	TWiMODLR_DevMgmt_FwInfo *	info,
		UINT8 *	statusRsp
	)

virtual

GetFirmwareInfo Cmd - Get basic info about the running firmware.

Parameters

info	pointer to store the received information
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ GetHCIConfig()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetHCIConfig	(	TWiMODLR_DevMgmt_HciConfig *	hciConfig,
		UINT8 *	statusRsp
	)

virtual

SetHCIConfig Cmd - Gets the HCI config options for the LR-BASE_PLUS firmware.

Parameters

hciConfig	pointer to store the received information
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ GetOperationMode()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetOperationMode	(	TWiMOD_OperationMode *	opMode,
		UINT8 *	statusRsp
	)

virtual

GetOperationMode Cmd - Get the current operation mode of the WiMOD.

Parameters

opMode	pointer to store the received information
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ GetRadioConfig()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetRadioConfig	(	TWiMODLR_DevMgmt_RadioConfig *	radioCfg,
		UINT8 *	statusRsp
	)

virtual

GetRadioConfig Cmd - Get the radio settings of the WiMOD.

Parameters

radioCfg	pointer to store the received information
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_Lorawan, and WiMOD_SAP_DevMgmt_Plus.

◆ GetRtc()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetRtc	(	UINT32 *	rtcTime,
		UINT8 *	statusRsp
	)

virtual

GetRtc Cmd - Get the current RTC time/date from WiMOD.

Parameters

rtcTime	pointer to store the received information
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ GetRtcAlarm()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetRtcAlarm	(	TWiMODLR_DevMgmt_RtcAlarm *	rtcAlarm,
		UINT8 *	statusRsp
	)

virtual

GetRtcAlarm Cmd - Get information about RTC alarm feature.

Parameters

rtcAlarm	pointer where to store the RTC alarm parameter set
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ GetSystemStatus()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::GetSystemStatus	(	TWiMODLR_DevMgmt_SystemStatus *	info,
		UINT8 *	statusRsp
	)

virtual

GetSystemStatus Cmd - Get basic info about the system status of WiMOD.

Parameters

info	pointer to store the received information
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_ProLink, WiMOD_SAP_DevMgmt_Lorawan, and WiMOD_SAP_DevMgmt_Plus.

◆ Ping()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::Ping ( UINT8 * statusRsp )

virtual

Ping Cmd - Checks if the serial connection of to the WiMOD module is OK.

Parameters

statusRsp pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ RegisterPowerUpIndicationClient()

void WiMOD_SAP_DevMgmt::RegisterPowerUpIndicationClient ( TDevMgmtPowerUpCallback cb )

Register a callback function for processing a PowerUp Indication message.

Parameters

cb	pointer to callback function

◆ RegisterRtcAlarmIndicationClient()

void WiMOD_SAP_DevMgmt::RegisterRtcAlarmIndicationClient ( TDevMgmtRtcAlarmCallback cb )

Register a callback function for processing a RTC Alarm Indication message.

Parameters

cb	pointer to callback function

◆ Reset()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::Reset ( UINT8 * statusRsp )

virtual

Reset Cmd - Do a reset / reboot of the WiMOD.

Parameters

statusRsp pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ ResetRadioConfig()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::ResetRadioConfig ( UINT8 * statusRsp )

virtual

ResetRadioConfig Cmd - Reset the radio config to factory defaults.

Parameters

statusRsp pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_Lorawan.

◆ SetAesKey()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::SetAesKey	(	const UINT8 *	key,
		UINT8 *	statusRsp
	)

virtual

SetAesKey Cmd - Set the 128bit AES that is to be used for encryption.

Parameters

key	pointer to the 128bit AES key (pointer to array of 16 UINT8 entries)
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_Lorawan.

◆ SetHCIConfig()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::SetHCIConfig	(	TWiMODLR_DevMgmt_HciConfig &	hciConfig,
		UINT8 *	statusRsp
	)

virtual

SetHCIConfig Cmd - Sets the HCI config options for the LR-BASE_PLUS firmware.

Parameters

hciConfig	pointer to the new configuration
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ SetOperationMode()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::SetOperationMode	(	const TWiMOD_OperationMode	opMode,
		UINT8 *	statusRsp
	)

virtual

SetOperationMode Cmd - Set the current operation mode of the WiMOD.

Parameters

opMode	the new operation mode to set
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ SetRadioConfig()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::SetRadioConfig	(	const TWiMODLR_DevMgmt_RadioConfig *	radioCfg,
		UINT8 *	statusRsp
	)

virtual

SetRadioConfig Cmd - Set the radio settings of the WiMOD.

Parameters

radioCfg	pointer to the new radio configuration
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_Lorawan, and WiMOD_SAP_DevMgmt_Plus.

◆ SetRadioMode()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::SetRadioMode	(	const TRadioCfg_RadioMode	radioMode,
		UINT8 *	statusRsp
	)

virtual

SetRadioMode - Set the current radio mode of the WiMOD.

Parameters

radioMode	the new radio mode to set
statusRsp	pointer to store status byte of response mesg from WiMOD

Warning: : This use this command with care!

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

Reimplemented in WiMOD_SAP_DevMgmt_Lorawan.

◆ SetRtc()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::SetRtc	(	const UINT32	rtcTime,
		UINT8 *	statusRsp
	)

virtual

SetRtc Cmd - Set the current RTC time/date of WiMOD.

Parameters

rtcTime	32bit data containing the new RTC timestamp
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

◆ SetRtcAlarm()

TWiMODLRResultCodes WiMOD_SAP_DevMgmt::SetRtcAlarm	(	const TWiMODLR_DevMgmt_RtcAlarm *	rtcAlarm,
		UINT8 *	statusRsp
	)

virtual

SetRtcAlarm Cmd - Set a new RTC alarm config.

Parameters

rtcAlarm	pointer to write the RTC alarm relevant parameter set to
statusRsp	pointer to store status byte of response mesg from WiMOD

Return values

WiMODLR_RESULT_OK if command transmit to WiMOD was ok

The documentation for this class was generated from the following files:

SAP/WiMOD_SAP_DEVMGMT.h
SAP/WiMOD_SAP_DEVMGMT.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WiMOD_SAP_DevMgmt()

Member Function Documentation

◆ ClearRtcAlarm()

◆ GetAesKey()

◆ GetDeviceInfo()

◆ GetFirmwareInfo()

◆ GetHCIConfig()

◆ GetOperationMode()

◆ GetRadioConfig()

◆ GetRtc()

◆ GetRtcAlarm()

◆ GetSystemStatus()

◆ Ping()

◆ RegisterPowerUpIndicationClient()

◆ RegisterRtcAlarmIndicationClient()

◆ Reset()

◆ ResetRadioConfig()

◆ SetAesKey()

◆ SetHCIConfig()

◆ SetOperationMode()

◆ SetRadioConfig()

◆ SetRadioMode()

◆ SetRtc()

◆ SetRtcAlarm()