Skip to content

Commit

Permalink
documentation updates prior to release (#26)
Browse files Browse the repository at this point in the history
* documentation updates prior to release

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: Blaise Thompson <blaise@chai.chem.wisc.edu>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Mar 10, 2023
1 parent 97a2de3 commit 5ac76b9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).

## [Unreleased]

### Changed
- in responses, device_status and response_code are now unpacked as two separate bytes
- data with bytecount of 2 has status only, and now returns immediately

## [2022.8.2]

### Fixed
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ Generic Response
| `command_name` | `<str>` |
| `data` | `<bytes>` |
| `full_response` | `<bytes>` |
| `status` | `<int>` |
| `device_status` | `<bytes>` |
| `response_code` | `<bytes>` |

You can parse the raw `data` according to the particulars of your peripheral.
Certain standard responses are parsed further as shown below.
Expand All @@ -109,7 +110,7 @@ Response 0
| `number_response_preamble_charachters` | `<int>` |
| `software_revision_level` | `<int>` |
| `transmitter_specific_command_revision_level` | `<int>` |
| `universal_command_revision_level | `<int>` |
| `universal_command_revision_level` | `<int>` |

Response 1
| key | value |
Expand All @@ -130,7 +131,9 @@ Response 11
| `number_response_preamble_charachters` | `<int>` |
| `software_revision_level` | `<int>` |
| `transmitter_specific_command_revision_level` | `<int>` |
| `universal_command_revision_level | `<int>` |
| `universal_command_revision_level` | `<int>` |

Many other universal and common responses are also parsed..., give it a try!

## Integration Example

Expand Down

0 comments on commit 5ac76b9

Please sign in to comment.