@awarns/battery

This framework module includes a task that allows to access phone's battery level on demand.

Install the plugin using the following command line instruction:

ns plugin add @awarns/battery

Usage

After installing and setting up this plugin, you'll have access to a task that allows to acquire the current phone's battery level and the BatteryLevel record that it will output on demand.

Tasks

Acquire phone's battery level

To register this task for its use, you just need to import it and call its generator function inside your application's task list:

import { Task } from '@awarns/core/tasks';
import { acquireBatteryLevelTask } from '@awarns/battery';

export const demoTasks: Array<Task> = [
  // ... other tasks
  acquireBatteryLevelTask(),
  // ...
];

Task generator parameters:

The task generator takes no parameters.

Task output events:

• batteryLevelAcquired

Example usage in the application task graph:

on('startEvent', run('acquirePhoneBatteryLevel')
  .every(1, 'minutes')
  .cancelOn('stopEvent'));

on('batteryLevelAcquired', run('writeRecords'))

Note: To use the writeRecords task, the persistence package must be installed and configured. See persistence package docs.

Events

Records

BatteryLevel

License

Apache License Version 2.0