Closed JaeminBBQ closed 1 year ago
Pretty straight forward. Please see my comments below (some process changes, some code changes and comments on testing results).
CFL standard github workflow
. Currently, if someone installs the linked firmware binary, to them, there will be no difference between this "still in dev firmware" to the one linked in the latest release because they are both v1.8.1
. This can be quite dangerous since we don't yet have complete traceability of the dependencies.
info.json
file created when a recording is started is the same as the one created with the currect release.info.json
fileskdiff3
to make your life easier in the comparison.Some notes about PR organization:
Added free_memory() to display during bootup
is currently floating in the PR description. Probably nesting it under an appropriate heading is better. Remember, the description is the first thing a reviewer (or anyone else) will read when coming to this PR. making it super clear what the PR does will help avoid confusion.Results
section, its better to have a table or a itemized list to highlight the tests run. Lets conform to this requirement and structure the results section accordingly.
Feature Tests
section should hold the test headings to any tests linked from the EmotiBit Feature test protocol
doc. If you did not add any feature tests, then it is OK to leave that section blank.I have not personally run the code yet. I will wait to test it after you make the changes (at least till you bump the firmware version).
Also, please feel free to add/update examples to any docs you may have referenced to create this PR. For example, adding an example about how to change the firmware version in the CFL standard github workflow
will be helpful!
Review complete. @JaeminBBQ
Changed implementation for handling non-existent field in config file. Link to comment: https://github.com/EmotiBit/EmotiBit_FeatherWing/pull/278/files#r1232736934
✔️ incomplete/wrong config file handling (missing SSID field changed to "") For a config file with contents
{
"WifiCredentials": [
{
"ssid": "brainwaves2.4",
"password": "brainwaves"
},
{
"password": "emotibitRocks" // notice missing SSID field
},
{
"ssid": "redacted",
"password": "redacted"
}
]
}
✔️ Differences between info.json files
@JaeminBBQ I made some minor changes in the code, take a look at this comment. I also tested it working for config files and info files. Looks good!
Let merge to master. Remember to complete the FW merge checklist in the PR description ☝🏽 .Make sure to pull before you make the changes to avoid conflicts.
Description
Updating the ArduinoJson library to the latest version and added free_memory() to display during bootup.
Requirements
Issues Referenced
Documentation update
Documentation should be changed under: Keeping EmotiBit up-to date => Update firmware using Arduino IDE => Library List where "ArduinoJson (version 5.13.5, not v6.x.x)" should be replaced with "ArduinoJson" since it is the latest version.
PR to documentation change.
Notes for Reviewer
Testing
Results
Test to make sure the
info.json
file created when a recording is started is the same as the one created with the currect release.The library update reduces the memory used by the EmotiBit which was checked using the free memory function as seen here.
Feature Tests
Add the test heading from "EmotiBit Feature Test Protocol" here.
Steps to test
Import the steps from the
EmotiBit Feature Test Protocol
for quick access for the reviewerShared files
Firmware binary: 1.8.1.fix-JsonLibUpdate.1.zip
Other files.
Checklist to allow merge
master
ofxEmotiBitVersion.h
DIGITAL_WRITE_DEBUG
= false (if set true while testing)