battery.h File Reference

Battery measurement task. More...

#include <zephyr/kernel.h>
#include <infuse/tdf/definitions.h>
#include <infuse/task_runner/task.h>
#include <infuse/task_runner/schedule.h>
#include <infuse/task_runner/tasks/infuse_task_ids.h>
#include <infuse/task_runner/tasks/battery.h>

Go to the source code of this file.

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

Battery measurement task.

Copyright

2024 Embeint Holdings Pty Ltd

Author

Jordan Yates jorda.nosp@m.n@em.nosp@m.beint.nosp@m..com

SPDX-License-Identifier: FSL-1.1-ALv2

Macro Definition Documentation

BATTERY_TASK

#define BATTERY_TASK	(		define_mem,
			define_config,
			bat_ptr )

Value:

        IF_ENABLED(define_config, ({.name = "bat",                                                 \
                                    .task_id = TASK_ID_BATTERY,                                    \
                                    .exec_type = TASK_EXECUTOR_WORKQUEUE,                          \
                                    .flags = TASK_FLAG_ARG_IS_DEVICE,                              \
                                    .task_arg.dev = bat_ptr,                                       \
                                    .executor.workqueue = {                                        \
                                            .worker_fn = battery_task_fn,                          \
                                    }}))

Battery task.

Parameters

define_mem	Define memory
define_config	Define task
bat_ptr	Fuel-gauge device bound to task

Function Documentation

battery_task_fn()

void battery_task_fn

(

struct k_work *

work

)

Battery task function.

Parameters

work	Delayable 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 )

Manually run the core battery sampling logic.

Parameters

dev	Fuel gauge device
args	Task arguments
tdf	Battery parameters that were measured

Return values

0	on success
-errno	on failure