CellularPower Class Reference

virtual Destructor

Definition at line 38 of file CellularPower.h.

Check whether the device is ready to accept commands.

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularPower.

Set cellular device power off.

Default implementation is empty. Device power on/off is modem/board specific behavior and must be done on inherited class if needed. Power off is done by toggling power pin/button.

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if not overridden by the target modem

Implemented in AT_CellularPower.

Set cellular device power on.

Default implementation is empty. Device power on/off is modem/board specific behavior and must be done on inherited class if needed. Power on is done by toggling power pin/button.

Remarks:

set_at_mode must be called to initialise modem

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if not overridden by the target modem

Implemented in AT_CellularPower.

Opt for power save setting on cellular device.

If both parameters are zero, this disables PSM.

Remarks:

See 3GPP TS 27.007 PSM for details

Parameters:

periodic_time	Timeout in seconds IoT subsystem is not expecting messaging
active_time	Timeout in seconds IoT subsystem waits for response

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularPower.

Opt for discontinuous reception on cellular device.

Remarks:

See 3GPP TS 27.007 eDRX for details.

Parameters:

mode	disable or enable the use of eDRX
act_type	type of access technology
edrx_value	requested edxr value. Extended DRX parameters information element.

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularPower.

Removes the device ready urc from the list of urc's.

Parameters:

callback

callback to remove from the list of urc's

Implemented in AT_CellularPower.

Reset and wake-up cellular device.

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularPower.

Set AT command mode.

Blocking until success or failure.

Remarks:

must be called after power on to prepare correct AT mode

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularPower.

Set URC callback function for device specific ready urc.

URC is defined in device specific power API. Used in startup sequence to listen when device is ready for using at commands and possible sim.

Parameters:

callback

Callback function called when urc received

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_NO_MEMORY on memory failure NSAPI_ERROR_UNSUPPORTED if not overridden by the target modem

Implemented in AT_CellularPower.

Set cellular device power level by enabling/disabling functionality.

Parameters:

func_level,:

0 minimum functionality 1 full functionality. Enable (turn on) the transmit and receive RF circuits for all supported radio access technologies. For MTs supporting +CSRA, this equals the RATs indicated by the response of +CSRA=?. Current +CSRA setting is ignored. It is not required that the MT transmit and receive RF circuits are in a disabled state for this setting to have effect. 2 disable (turn off) MT transmit RF circuits only 3 disable (turn off) MT receive RF circuits only 4 disable (turn off) both MT transmit and receive RF circuits

do_reset

0 for do not reset, 1 for reset the device when changing the functionality

Remarks:

See 3GPP TS 27.007 CFUN for more details

Returns:

NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularPower.