Device object implementation for LwM2M client using Wakaama. More...

Detailed Description

Device object implementation for LwM2M client using Wakaama.

Files

file  device.h
 

Enumerations

enum  lwm2m_device_resources {
  LWM2M_RES_MANUFACTURER = 0, LWM2M_RES_MODEL_NO, LWM2M_RES_SERIAL, LWM2M_RES_FW_VER,
  LWM2M_RES_REBOOT, LWM2M_RES_FRESET, LWM2M_RES_POWER_SRC, LWM2M_RES_POWER_VOL,
  LWM2M_RES_POWER_AMP, LWM2M_RES_BATTERY_LEVEL, LWM2M_RES_MEM_FREE, LWM2M_RES_ERROR_CODE,
  LWM2M_RES_ERROR_CODE_RESET, LWM2M_RES_TIME, LWM2M_RES_TIME_OFFSET, LWM2M_RES_TIME_ZONE,
  LWM2M_RES_BINDINGS, LWM2M_RES_TYPE, LWM2M_RES_HW_VERSION, LWM2M_RES_SW_VERSION,
  LWM2M_RES_BATTERY_STATUS, LWM2M_RES_MEM_TOTAL, LWM2M_RES_EXT_DEV_INFO, LWM2M_DEVICE_RESOURCES
}
 Resources of the LwM2M device object instance. More...
 
enum  lwm2m_device_error_codes {
  LWM2M_DEVICE_ERR_NO_ERR = 0, LWM2M_DEVICE_ERR_LOW_BATT = 1, LWM2M_DEVICE_ERR_EXT_OFF = 2, LWM2M_DEVICE_ERR_GPS_ERR = 3,
  LWM2M_DEVICE_ERR_LOW_SIGNAL = 4, LWM2M_DEVICE_ERR_NO_MEM = 5, LWM2M_DEVICE_ERR_SMS_ERR = 6, LWM2M_DEVICE_ERR_IP_ERR = 7,
  LWM2M_DEVICE_ERR_PERIPH_ERR = 8
}
 Error codes for the Error resource in the device object of LwM2M. More...
 

Functions

void lwm2m_free_object_device (lwm2m_object_t *obj)
 Frees the memory of obj device object. More...
 
bool lwm2m_device_reboot_requested (void)
 Determines if a reboot request has been issued to the device by a server. More...
 

Enumeration Type Documentation

◆ lwm2m_device_error_codes

Error codes for the Error resource in the device object of LwM2M.

Enumerator
LWM2M_DEVICE_ERR_NO_ERR 

No error.

LWM2M_DEVICE_ERR_LOW_BATT 

Low battery power.

LWM2M_DEVICE_ERR_EXT_OFF 

External power supply off.

LWM2M_DEVICE_ERR_GPS_ERR 

GPS module failure.

LWM2M_DEVICE_ERR_LOW_SIGNAL 

Low received signal strength.

LWM2M_DEVICE_ERR_NO_MEM 

Out of memory.

LWM2M_DEVICE_ERR_SMS_ERR 

SMS failure.

LWM2M_DEVICE_ERR_IP_ERR 

IP connectivity failure.

LWM2M_DEVICE_ERR_PERIPH_ERR 

Peripheral malfunction.

Definition at line 71 of file device.h.

◆ lwm2m_device_resources

Resources of the LwM2M device object instance.

See also
http://www.openmobilealliance.org/tech/profiles/LWM2M_Device-v1_0_3.xml
Enumerator
LWM2M_RES_MANUFACTURER 

Human readable manufacturer name.

LWM2M_RES_MODEL_NO 

Model identifier (manufacturer specified string)

LWM2M_RES_SERIAL 

Serial number.

LWM2M_RES_FW_VER 

Current firmware version of the device.

LWM2M_RES_REBOOT 

Reboot the device.

LWM2M_RES_FRESET 

Perform a factory reset of the device.

LWM2M_RES_POWER_SRC 

Available power sources.

LWM2M_RES_POWER_VOL 

Present voltage for each power source.

LWM2M_RES_POWER_AMP 

Present current for each power source.

LWM2M_RES_BATTERY_LEVEL 

Current battery level as a percentage.

LWM2M_RES_MEM_FREE 

Estimated current available storage (kB)

LWM2M_RES_ERROR_CODE 

Last error code.

LWM2M_RES_ERROR_CODE_RESET 

Delete all error code instances.

LWM2M_RES_TIME 

Current UNIX time of the client.

LWM2M_RES_TIME_OFFSET 

Indicated the UTC offset for the device.

LWM2M_RES_TIME_ZONE 

Indicates the time zone of the device.

LWM2M_RES_BINDINGS 

Indicates supported bindings and modes on the client.

LWM2M_RES_TYPE 

Type of device.

LWM2M_RES_HW_VERSION 

Current hardware version of the device.

LWM2M_RES_SW_VERSION 

Current software version on the device.

LWM2M_RES_BATTERY_STATUS 

Battery status when internal battery is present.

LWM2M_RES_MEM_TOTAL 

Total amount of storage space in the device (kB.

LWM2M_RES_EXT_DEV_INFO 

External device object instance.

LWM2M_DEVICE_RESOURCES 

Number of resources.

Definition at line 39 of file device.h.

Function Documentation

◆ lwm2m_device_reboot_requested()

bool lwm2m_device_reboot_requested ( void  )

Determines if a reboot request has been issued to the device by a server.

Returns
true reboot has been requested
false reboot has not been requested

◆ lwm2m_free_object_device()

void lwm2m_free_object_device ( lwm2m_object_t *  obj)

Frees the memory of obj device object.

Parameters
[in]objpointer to the device object