Skip to content

Commit

Permalink
docs: correct documentation [#2]
Browse files Browse the repository at this point in the history
  • Loading branch information
softwaredeliverybot committed Nov 26, 2024
1 parent 2917fa3 commit c7ffa26
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

Install the latest version from [pypi](https://pypi.org/):
```bash
pip install umrx-v3-py
pip install umrx-app-v3
```

The `umrx-v3-py` project implements in `python3` COINES communication protocol
to control the micro-controller (MCU) and read the sensor data from the
The `umrx-app-v3` project implements in `python3` COINES communication protocol
to interact with the micro-controller (MCU) and read the sensor data from the
[Application Board 3.1](https://www.bosch-sensortec.com/software-tools/tools/application-board-3-1/) and
[3.0](https://www.bosch-sensortec.com/software-tools/tools/application-board-3-0/) when
board is programmed with BST default firmware.
Expand All @@ -35,10 +35,10 @@ and
* Read / write the sensor registers using the SPI protocol;
* Configure and receive streaming packets:
* **Polling** streaming: sensor registers are read in bulk at regular intervals;
* **Interrupt** streaming: sensor registers are read in bulk when sensor reports data ready over interrupt pin.
* **Interrupt** streaming: sensor registers are read in bulk when sensor reports data ready over interrupt pin;
* Switch application to
[DFU](https://www.usb.org/document-library/device-firmware-upgrade-11-new-version-31-aug-2004) or
[MTP](https://en.wikipedia.org/wiki/Media_Transfer_Protocol)
[MTP](https://en.wikipedia.org/wiki/Media_Transfer_Protocol);
* Enable MCU time stamp (works only with Application Board 3.0).


Expand Down Expand Up @@ -125,7 +125,7 @@ Execute the python scripts with `sudo` to read/write USB device.
### Install using pip

```bash
pip install umrx-v3-py
pip install umrx-app-v3
```


Expand Down
5 changes: 1 addition & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "poetry_dynamic_versioning.backend"
[tool.poetry]
name = "umrx-app-v3"
version = "0.0.0"
description = "Python COINES firmware communication"
description = "Communication with COINES firmware for humans"
authors = [
"Konstantin Selyunin <selyunin.k.v@gmail.com>",
]
Expand Down Expand Up @@ -36,9 +36,6 @@ safety = ">=2.3.4,!=2.3.5"
typeguard = ">=3.0.2"
unittest-parametrize = "^1.4.0"

[tool.poetry-dynamic-versioning]
enable = true


[tool.coverage.report]
fail_under = 50
Expand Down

0 comments on commit c7ffa26

Please sign in to comment.