Skip to content

Commit 23e0349

Browse files
committed
Update ADDING_SENSORS.md
1 parent 922d5ab commit 23e0349

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

ADDING_SENSORS.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ These are _abbreviated_ instructions on how to add a new sensor to the OLA firm
44

55
Caveat: this is _currently_ how a new sensor is added, for version v1.n of the OLA firmware using v1.2.n of the Apollo3 boards (the OLA code is compiled using the SparkFun RedBoard Artemis ATP (All The Pins) board). This will change, dramatically, when we upgrade to v2 of Apollo3 and integrate BLE support.
66

7-
## Release Candidate Branch
7+
## Use The Release Candidate Branch
88

99
First up, please target any commits at the _**release_candidate**_ branch, so they can be tested before being merged into the _master_ branch.
1010

@@ -34,7 +34,7 @@ First up, please target any commits at the _**release_candidate**_ branch, so th
3434

3535
### beginQwiicDevices
3636

37-
- This is the code that is called to start (begin) the device. [Add a case for the new sensor](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-68cc245ab0d3c1bed2bfc22b403edc3ed73d347a35a21179b3a6ec27a458803bR453-R461)
37+
- This is the code that is called to start (begin) the device. [Add a case for the new sensor](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-68cc245ab0d3c1bed2bfc22b403edc3ed73d347a35a21179b3a6ec27a458803bR453-R461). Update _qwiicPowerOnDelayMillis_ if this device needs extra time to get its act together on power-up.
3838

3939
### configureDevice
4040

@@ -54,7 +54,7 @@ First up, please target any commits at the _**release_candidate**_ branch, so th
5454

5555
### getDeviceName
5656

57-
- This is where the sensor name is defined as text. [Add a case for the new sensor](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-68cc245ab0d3c1bed2bfc22b403edc3ed73d347a35a21179b3a6ec27a458803bR1423-R1425)
57+
- This is where the sensor name is defined as text. [Add a case for the new sensor](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-68cc245ab0d3c1bed2bfc22b403edc3ed73d347a35a21179b3a6ec27a458803bR1423-R1425). Keep it brief and follow the same format as the other sensors: usually _TYPE_ (PRESSURE, TEMPERATURE etc.) followed by the abbreviated manufacturer's part number
5858

5959
## menuAttachedDevices.ino
6060

@@ -64,7 +64,7 @@ First up, please target any commits at the _**release_candidate**_ branch, so th
6464

6565
### menuConfigure_
6666

67-
- [Add a new menuConfigure_ for the new sensor](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-6174875faf8039f2627c16aaf48e4db57f5a2c8c883061ac97202d74e9a46ef8R2026-R2133)
67+
- [Add a new menuConfigure_ for the new sensor](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-6174875faf8039f2627c16aaf48e4db57f5a2c8c883061ac97202d74e9a46ef8R2026-R2141)
6868
- Boolean settings are simple to toggle. [Make them exclusive if you need to](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-6174875faf8039f2627c16aaf48e4db57f5a2c8c883061ac97202d74e9a46ef8R1942-R1948)
6969
- _int64_t_ values are requested using _getNumber_ (defined in support.ino)
7070
- _double_ values are requested using _getDouble_ (defined in support.ino)
@@ -88,3 +88,12 @@ First up, please target any commits at the _**release_candidate**_ branch, so th
8888
### settings struct
8989

9090
- [Add a settings struct for the new sensor](https://github.com/sparkfun/OpenLog_Artemis/commit/2a26acd279fa93cfe84f1bc518c0e7a041b3bc44#diff-c853eddd04f78093fed5ec20b822c3c224bfa5f268738ce4c479b45667f86fe9R265-R281). Include both _log_ and _powerOnDelayMillis_
91+
92+
## README.md
93+
94+
- Add the new sensor to the list in [README.md](./README.md). Include a link to the product page
95+
- Update the OLA product page on Sparkle - add the new sensor to the list
96+
97+
## CHANGELOG.md
98+
99+
- Update [CHANGELOG.md](./CHANGELOG.md). Start a new version if you need to. Add the new sensor to the change notes

0 commit comments

Comments
 (0)