Skip to content

Commit

Permalink
Updated README to better reflect firmware compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
dcyoung committed Apr 27, 2017
1 parent fa883c3 commit 68042b7
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions libsweep/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,20 +82,24 @@ Before jumping into details, here are the library's main design ideas:
- Fixed-size and signed integers for portability and runtime checking (think sanitizers).

Table of Contents:
- [Firmware Compatibility](#firmware-compatibility)
- [Version and ABI Management](#version-and-abi-management)
- [Error Handling](#error-handling)
- [Device Interaction](#device-interaction)
- [Full 360 Degree Scan](#full-360-degree-scan)


#### Version And ABI Management
Compatibility:

#### Firmware Compatibility
| libsweep | sweep firmware |
| -------- | :------------: |
| v1.x.x | v1.1 |
| v1.1.1 | v1.2 |
| v1.1.0 | v1.1 |
| v0.x.x | v1.0 |

You can check the firmware version installed on your sweep device by using a serial terminal (see [manual](https://s3.amazonaws.com/scanse/Sweep_user_manual.pdf)) or more easily using the sweep visualizer (see [instructions](https://support.scanse.io/hc/en-us/articles/224557908-Upgrading-Firmware)).


#### Version And ABI Management

```c++
SWEEP_VERSION_MAJOR
```
Expand Down

0 comments on commit 68042b7

Please sign in to comment.