Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
linguini1 committed Nov 30, 2023
1 parent 3013e52 commit 3d825bb
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# fetcher

A QNX process for fetching data from sensors over I2C.

**NOTE:** This program is currently in a dummy format: it is being used to read data from a file and repeat it over
stdin. This is used for testing [packager][packager].
A process for fetching data from sensors using the I2C protocol.

## Usage

See the help documentation with the command: `use fetcher`
See the help documentation with the command: `use fetcher`.

The output of fetcher looks like:

```console
Time: 1295 ms
Temperature: 25.02 C
Pressure: 99.94 kPa
...
```

All sensor data output is printed in plain-text, with its type specifier (i.e. temperature), its value and its unit.

<!--- Links --->
[packager]: https://github.com/CarletonURocketry/packager

[packager]: https://github.com/CarletonURocketry/packager

0 comments on commit 3d825bb

Please sign in to comment.