Infuse-IoT SDK API 0.0.1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Battery measurement task

Macros

#define BATTERY_TASK(define_mem, define_config, bat_ptr)
 Battery task.

Functions

void battery_task_fn (struct k_work *work)
 Battery task function.
int task_battery_manual_run (const struct device *dev, const struct task_battery_args *args, struct tdf_battery_state *tdf)
 Manually run the core battery sampling logic.

Detailed Description

Macro Definition Documentation

◆ BATTERY_TASK

#define BATTERY_TASK ( define_mem,
define_config,
bat_ptr )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/task_runner/tasks/battery.h>

Value:
IF_ENABLED(define_config, ({.name = "bat", \
.task_id = TASK_ID_BATTERY, \
.exec_type = TASK_EXECUTOR_WORKQUEUE, \
.task_arg.dev = bat_ptr, \
.executor.workqueue = { \
.worker_fn = battery_task_fn, \
}}))
@ TASK_ID_BATTERY
Battery task arguments (task_battery_args)
Definition infuse_task_ids.h:33
@ TASK_FLAG_ARG_IS_DEVICE
task_arg union is a device pointer
Definition task.h:39
@ TASK_EXECUTOR_WORKQUEUE
Task runs on the system workqueue.
Definition task.h:34
void battery_task_fn(struct k_work *work)
Battery task function.

Battery task.

Parameters
define_memDefine memory
define_configDefine task
bat_ptrFuel-gauge device bound to task

Function Documentation

◆ battery_task_fn()

void battery_task_fn ( struct k_work * work)

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/task_runner/tasks/battery.h>

Battery task function.

Parameters
workDelayable work item

◆ task_battery_manual_run()

int task_battery_manual_run ( const struct device * dev,
const struct task_battery_args * args,
struct tdf_battery_state * tdf )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/include/infuse/task_runner/tasks/battery.h>

Manually run the core battery sampling logic.

Parameters
devFuel gauge device
argsTask arguments
tdfBattery parameters that were measured
Return values
0on success
-errnoon failure