patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

net: lwm2m: add uCIFI Battery object (3411)

Browse source 
Add the uCIFI Battery object to support
monitoring a devices battery.

Signed-off-by: Ryan Erickson <ryan.erickson@lairdconnect.com>
This commit is contained in:
Ryan Erickson 2022-01-13 09:49:37 -06:00 committed by Anas Nashif
parent 4557d183b9
commit c6ace45a6c
6 changed files with 219 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
include/net/lwm2m.h
View file

@ -67,6 +67,7 @@
#define IPSO_OBJECT_TIMER_ID 3340
#define IPSO_OBJECT_ONOFF_SWITCH_ID 3342
#define IPSO_OBJECT_PUSH_BUTTON_ID 3347
#define UCIFI_OBJECT_BATTERY_ID 3411
#define IPSO_OBJECT_FILLING_LEVEL_SENSOR_ID 3435
/* clang-format on */

3
subsys/net/lib/lwm2m/CMakeLists.txt
View file

@ -83,5 +83,8 @@ zephyr_library_sources_ifdef(CONFIG_LWM2M_IPSO_CURRENT_SENSOR
zephyr_library_sources_ifdef(CONFIG_LWM2M_IPSO_FILLING_SENSOR
ipso_filling_sensor.c
)
zephyr_library_sources_ifdef(CONFIG_LWM2M_UCIFI_BATTERY
ucifi_battery.c
)
zephyr_library_link_libraries_ifdef(CONFIG_MBEDTLS mbedTLS)

6
subsys/net/lib/lwm2m/Kconfig
View file

@ -474,4 +474,10 @@ source "subsys/net/lib/lwm2m/Kconfig.ipso"
endmenu
menu "uCIFI Alliance Object Support"
source "subsys/net/lib/lwm2m/Kconfig.ucifi"
endmenu
endif # LWM2M

28
subsys/net/lib/lwm2m/Kconfig.ucifi Normal file
View file

@ -0,0 +1,28 @@
# Copyright (c) 2022 Laird Connectivity
# SPDX-License-Identifier: Apache-2.0
menuconfig LWM2M_UCIFI_SUPPORT
bool "uCIFI Alliance Object Support"
help
This option adds general support for uCIFI objects
if LWM2M_UCIFI_SUPPORT
menuconfig LWM2M_UCIFI_BATTERY
bool "uCIFI Battery (3411) Monitor Support"
help
The uCIFI battery object provides attributes to monitor battery
level and activity.
if LWM2M_UCIFI_BATTERY
config LWM2M_UCIFI_BATTERY_INSTANCE_COUNT
int "Maximum # of uCIFI Battery object instances"
default 1
help
This setting establishes the total count of uCIFI Battery
instances available to the LWM2M client.
endif # LWM2M_UCIFI_BATTERY
endif # LWM2M_UCIFI_SUPPORT

153
subsys/net/lib/lwm2m/ucifi_battery.c Normal file
View file

@ -0,0 +1,153 @@
/*
* Copyright (c) 2017 Linaro Limited
* Copyright (c) 2018-2019 Foundries.io
* Copyright (c) 2022 Laird Connectivity
*
* SPDX-License-Identifier: Apache-2.0
*/
/*
* Source material for uCIFI battery object (3411):
* https://raw.githubusercontent.com/OpenMobileAlliance/lwm2m-registry/prod/3411.xml
*/
#define LOG_MODULE_NAME net_ucifi_battery
#define LOG_LEVEL CONFIG_LWM2M_LOG_LEVEL
#include <logging/log.h>
LOG_MODULE_REGISTER(LOG_MODULE_NAME);
#include <stdint.h>
#include <init.h>
#include "lwm2m_object.h"
#include "lwm2m_engine.h"
#include "lwm2m_resource_ids.h"
#include "ucifi_battery.h"
#define BATTERY_VERSION_MAJOR 1
#define BATTERY_VERSION_MINOR 0
#define MAX_INSTANCE_COUNT CONFIG_LWM2M_UCIFI_BATTERY_INSTANCE_COUNT
#define BATTERY_MAX_ID 12
#define RESOURCE_INSTANCE_COUNT (BATTERY_MAX_ID)
/* resource state variables */
static uint8_t battery_level[MAX_INSTANCE_COUNT];
static uint32_t supply_loss_counter[MAX_INSTANCE_COUNT];
static struct lwm2m_engine_obj battery;
static struct lwm2m_engine_obj_field fields[] = {
OBJ_FIELD_DATA(UCIFI_BATTERY_LEVEL_RID, R, U8),
OBJ_FIELD_DATA(UCIFI_BATTERY_CAPACITY_RID, R_OPT, FLOAT),
OBJ_FIELD_DATA(UCIFI_BATTERY_VOLTAGE_RID, R_OPT, FLOAT),
OBJ_FIELD_DATA(UCIFI_BATTERY_TYPE_RID, RW_OPT, STRING),
OBJ_FIELD_DATA(UCIFI_BATTERY_LOW_THESHOLD_RID, RW_OPT, U8),
OBJ_FIELD_DATA(UCIFI_BATTERY_LEVEL_TOO_LOW_RID, R_OPT, BOOL),
OBJ_FIELD_DATA(UCIFI_BATTERY_SHUTDOWN_RID, RW_OPT, BOOL),
OBJ_FIELD_DATA(UCIFI_BATTERY_NUM_CYCLES_RID, R_OPT, U32),
OBJ_FIELD_DATA(UCIFI_BATTERY_SUPPLY_LOSS_RID, R_OPT, BOOL),
OBJ_FIELD_DATA(UCIFI_BATTERY_SUPPLY_LOSS_COUNTER_RID, R_OPT, U32),
OBJ_FIELD_EXECUTE_OPT(UCIFI_BATTERY_SUPPLY_LOSS_COUNTER_RESET_RID),
OBJ_FIELD_DATA(UCIFI_BATTERY_SUPPLY_LOSS_REASON_RID, R_OPT, STRING),
};
static struct lwm2m_engine_obj_inst inst[MAX_INSTANCE_COUNT];
static struct lwm2m_engine_res res[MAX_INSTANCE_COUNT][BATTERY_MAX_ID];
static struct lwm2m_engine_res_inst res_inst[MAX_INSTANCE_COUNT][RESOURCE_INSTANCE_COUNT];
static void clear_supply_loss_counter(uint16_t obj_inst_id, int index)
{
supply_loss_counter[index] = 0;
NOTIFY_OBSERVER(UCIFI_OBJECT_BATTERY_ID, obj_inst_id,
UCIFI_BATTERY_SUPPLY_LOSS_COUNTER_RID);
}
static int supply_loss_counter_reset_cb(uint16_t obj_inst_id, uint8_t *args, uint16_t args_len)
{
int i;
LOG_DBG("RESET supply loss counter %d", obj_inst_id);
for (i = 0; i < MAX_INSTANCE_COUNT; i++) {
if (inst[i].obj && inst[i].obj_inst_id == obj_inst_id) {
clear_supply_loss_counter(obj_inst_id, i);
return 0;
}
}
return -ENOENT;
}
static struct lwm2m_engine_obj_inst *battery_create(uint16_t obj_inst_id)
{
int index, i = 0, j = 0;
/* Check that there is no other instance with this ID */
for (index = 0; index < MAX_INSTANCE_COUNT; index++) {
if (inst[index].obj && inst[index].obj_inst_id == obj_inst_id) {
LOG_ERR("Can not create instance - "
"already existing: %u",
obj_inst_id);
return NULL;
}
}
for (index = 0; index < MAX_INSTANCE_COUNT; index++) {
if (!inst[index].obj) {
break;
}
}
if (index >= MAX_INSTANCE_COUNT) {
LOG_ERR("Can not create instance - no more room: %u", obj_inst_id);
return NULL;
}
/* Set default values */
battery_level[index] = 0;
supply_loss_counter[index] = 0;
(void)memset(res[index], 0, sizeof(res[index][0]) * ARRAY_SIZE(res[index]));
init_res_instance(res_inst[index], ARRAY_SIZE(res_inst[index]));
/* initialize instance resource data */
INIT_OBJ_RES_DATA(UCIFI_BATTERY_LEVEL_RID, res[index], i, res_inst[index], j,
&battery_level[index], sizeof(*battery_level));
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_CAPACITY_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_VOLTAGE_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_TYPE_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_LOW_THESHOLD_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_LEVEL_TOO_LOW_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_SHUTDOWN_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_NUM_CYCLES_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_SUPPLY_LOSS_RID, res[index], i, res_inst[index], j);
INIT_OBJ_RES_DATA(UCIFI_BATTERY_SUPPLY_LOSS_COUNTER_RID, res[index], i, res_inst[index], j,
&supply_loss_counter[index], sizeof(*supply_loss_counter));
INIT_OBJ_RES_EXECUTE(UCIFI_BATTERY_SUPPLY_LOSS_COUNTER_RESET_RID, res[index], i,
supply_loss_counter_reset_cb);
INIT_OBJ_RES_OPTDATA(UCIFI_BATTERY_SUPPLY_LOSS_REASON_RID, res[index], i, res_inst[index],
j);
inst[index].resources = res[index];
inst[index].resource_count = i;
LOG_DBG("Create uCIFI Battery instance: %d", obj_inst_id);
return &inst[index];
}
static int ucifi_battery_init(const struct device *dev)
{
battery.obj_id = UCIFI_OBJECT_BATTERY_ID;
battery.version_major = BATTERY_VERSION_MAJOR;
battery.version_minor = BATTERY_VERSION_MINOR;
battery.is_core = false;
battery.fields = fields;
battery.field_count = ARRAY_SIZE(fields);
battery.max_instance_count = MAX_INSTANCE_COUNT;
battery.create_cb = battery_create;
lwm2m_register_obj(&battery);
return 0;
}
SYS_INIT(ucifi_battery_init, APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT);

28
subsys/net/lib/lwm2m/ucifi_battery.h Normal file
View file

@ -0,0 +1,28 @@
/**
* @file ucifi_battery.h
* @brief
*
* Copyright (c) 2022 Laird Connectivity
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef __LWM2M_UCIFI_BATTERY__
#define __LWM2M_UCIFI_BATTERY__
/* uCIFI Battery resource IDs */
/* clang-format off */
#define UCIFI_BATTERY_LEVEL_RID 1
#define UCIFI_BATTERY_CAPACITY_RID 2
#define UCIFI_BATTERY_VOLTAGE_RID 3
#define UCIFI_BATTERY_TYPE_RID 4
#define UCIFI_BATTERY_LOW_THESHOLD_RID 5
#define UCIFI_BATTERY_LEVEL_TOO_LOW_RID 6
#define UCIFI_BATTERY_SHUTDOWN_RID 7
#define UCIFI_BATTERY_NUM_CYCLES_RID 8
#define UCIFI_BATTERY_SUPPLY_LOSS_RID 9
#define UCIFI_BATTERY_SUPPLY_LOSS_COUNTER_RID 10
#define UCIFI_BATTERY_SUPPLY_LOSS_COUNTER_RESET_RID 11
#define UCIFI_BATTERY_SUPPLY_LOSS_REASON_RID 12
/* clang-format on */
#endif /* __LWM2M_UCIFI_BATTERY__ */