Skip to content

Commit f67699e

Browse files
authored
Update README.md
1 parent cb82935 commit f67699e

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,48 @@ This project is a C++ implementation of the MetaWear protocol. If compiled as a
99

1010
The library only constructs the bytes for communicating with the MetaWear platform, it **does not** contain any Bluetooth LE code. Users will need to fill in the appropriate Bluetooth LE functions for their target platform.
1111

12-
> ADDITIONAL NOTES
13-
This library is platform agnostic and does not contain any Bluetooth code. You are responsible for adding in this functionality.
12+
> This library is platform agnostic and does not contain any Bluetooth code. You are responsible for adding in this functionality.
13+
14+
Version 0.30.0 supports the following boards:
15+
- [x] MMS
16+
- [x] MMC
17+
- [x] MMR + MMRL
18+
- [ ] MetaTracker
19+
- [ ] MetaWear HR / PPG
20+
- [ ] MMM (mini)
21+
- [ ] MWR, MWRG, MWRGPro
22+
- [ ] MWC, MWCPro, MWCenv, MWCDetect
23+
- [ ] Custom boards
1424

1525
### Overview
16-
1726
[MetaWear](https://mbientlab.com) is a complete development and production platform for wearable and connected device applications.
1827

19-
MetaWear features a number of sensors and peripherals all easily controllable over Bluetooth 4.0/5.0 Low Energy using this SDK, no firmware or hardware experience needed!
20-
21-
The MetaWear hardware comes pre-loaded with a wirelessly upgradeable firmware, so it keeps getting more powerful over time.
28+
MetaWear features a number of sensors and peripherals (button, acceleromter, LED, gyroscope, magnetometer, ambient light, IOs...) all easily controllable over Bluetooth 4.0/5.0 Low Energy using this SDK.
2229

2330
### Requirements
2431
- [MetaWear board](https://mbientlab.com/store/)
2532
- A linux/mac/windows machine with Bluetooth 4.0 or Bluetooth 5.0
2633

2734
### Notes
28-
- Our tutorials will mostly reflect usage on ios and linux (see our SDKs)
29-
- Can work on macOS/iOS/OSX/tvOS (you may need to do some additional dev yourself - not documented/supported by Mbient)
30-
- Can work on Windows (you will need to do some additional dev yourself - not documented/supported by Mbient)
35+
- Our tutorials will mostly reflect usage on iOS and Linux (see our Swift, Python and Javascript SDKs)
36+
- Some Windows support is provided with Python.
3137

3238
### License
3339
See the [License](https://github.com/mbientlab/MetaWear-SDK-Cpp/blob/master/LICENSE.md).
3440

3541
### Support
36-
Reach out to the [community](https://mbientlab.com/community/) if you encounter any problems, or just want to chat :)
42+
Reach out to the [community](https://mbientlab.com/community/) if you encounter any problems.
3743

3844
## Getting Started
3945

4046
### Installation
41-
Building the project has been tested on Unix systems with Clang 4.
47+
Building the project has been tested on Linux Debian with Clang 15.
4248

4349
### Usage
4450

4551
```sh
4652
> clang++ --version
47-
clang version 4.0.1 (tags/RELEASE_401/final 305264)
53+
clang version 15.0.6
4854
Target: x86_64-unknown-linux-gnu
4955
```
5056
```bat
@@ -74,8 +80,8 @@ dist/
7480
└── lib
7581
└── x64
7682
├── libmetawear.so -> libmetawear.so.0
77-
├── libmetawear.so.0 -> libmetawear.so.0.20.9
78-
└── libmetawear.so.0.20.9
83+
├── libmetawear.so.0 -> libmetawear.so.0.30.0
84+
└── libmetawear.so.0.30.0
7985

8086
```
8187

@@ -99,5 +105,4 @@ OK (skipped=1)
99105
```
100106

101107
### Tutorials
102-
103108
Tutorials can be found [here](https://mbientlab.com/tutorials/).

0 commit comments

Comments
 (0)