Skip to content

add more methods to imu #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add more methods to imu #273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/tildagon-apps/reference/badge-hardware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,14 +462,18 @@ __app_export__ = ExampleApp

### Methods

The api currently only allows access to the raw data.
In order to support alternative imu devices a base set of functionality is provided along with i2c access to the device for apps to add functinality. An identify function is provided to determine which device is on the badge. Only the prototype badges have a different imu, but this may change in the future.

<!-- prettier-ignore -->
| Method | Description | Arguments | Returns |
| ------ | ----------- | --------- | ------- |
| `acc_read()` | Get the accelerometer data. | None | `(x,y,z)`: The accelerometer data as a tuple of floats (m/s^2). |
| `gyro_read()` | Get the gyro data. | None | `(x,y,z)`: The gyro data as a tuple of floats (d/s). |
| `step_counter_read()` | Get the step count | None | `count`: The step count |
| `temperature_read()` | Get the temperature | None | `temerature`: Temperature (°).|
| `id()` | Get the device id | None | `id`: string id of device. |
| `readfrom()` | Read from a device register| `(register address, length)`: address to start read from, length of read | `data`: bytes of the data or -ve error code. |
| `writeto()` | Write data to a device register | `(register address, bytes)`: address to start write to, data.| `error`: or None if ok. |

### Usage

Expand Down