Firmware Over-The-Air (OTA) update capability#118

Merged

aentinger merged 49 commits intomasterfrom

Jun 3, 2020

Commits on May 13, 2020

The topic name for the OTA input and output topic will be stored as member variables and is created using the syntax '/a/d//ota/i' and '/a/d//ota/o' respectively
aentinger
committed
Providing capability for a unified interface described via class OTAStorage for storing downloaded binaries on different media
aentinger
committed
Replacing direct storing of ota storage class with injecting it via 'setOTAStorage'
aentinger
committed
Subscribe to OTA in topic which is used to receive the update binary from the MQTT server
aentinger
committed
Adding first draft of class containing business logic for handling OTA updates as well as test code
aentinger
committed
Basic implementation of OTA business logic
aentinger
committed
Adding test code for invalid CRC32
aentinger
committed
Adding method to determine the type of the provide OTAStorage medium. This is necessary for reporting to the cloud what are the available OTA options
aentinger
committed
The type of the available OTA storage is set to the hidden property 'OTA_STORAGE_TYPE' which can be read by the cloud
aentinger
committed
Passing OTA storage object upon construction of OTALogic simplifies error checking in the business logic itself
aentinger
committed
The complete OTA storage medium handling is now encapsulated within the OTALogic class and does not need to be stored as a ArduinoIoTCloudTCP class member any longer
aentinger
committed
Pass on received OTA data to OTALogic is an OTALogic object has been instantiated
aentinger
committed
Adding enum class OTAError which allows a more granular feedback on the type of error which occured during the OTA process
aentinger
committed
Add OTAError::ChecksumMismatch which occures then the expected checksum does not match with the actual checksum
aentinger
committed
Only allow external access of internal state when using this for test build - its only needed for the test code and there is no need for the firmware to know the internal state of the OTALogic (onl…
aentinger
committed
Also directly return the error state when calling the update method
aentinger
committed
Adding fakeIt mock framework
aentinger
committed
Replacing self written OTAStorage_Mock with fakeit mocking framework
aentinger
committed
When the OTAStorage::init operation fails the OTA logic should transition to OTAState::Error and indicate that the error is of type OTAError::StorageInitFailed
aentinger
committed
When the opening of the file on the OTA storage device for the update file fails then the OTA logic should transition to the OTAState::Error state and set OTAError::StorageOpenFailed
aentinger
committed
When the writing to the file on the OTA storage device for the update file fails then the OTA logic should transition to the OTAState::Error state and set OTAError::StorageWritedFailed
aentinger
committed
Assigning defined values to the various error types in order to have defined numbers
aentinger
committed
ESP8266 isn't as advanced as Arduino framework concerning modern C++ usage. Although OTA for ESP8266 is currently no topic this code has had to be adjusted because otherwise the CI tests fail
aentinger
committed
Method 'error()' is only available when compiling for host, there is no need for it to be available for the target build since the member _ota_error is also available via 'update()'
aentinger
committed
Adding hidden property OTA_ERROR which contains an integer encoded error value if an error occured during OTA update
aentinger
committed
When a data overrun occurs because the MQTT OTA data buffer is full before its content can be processed by update() then we transition to OTAState::Error and set OTAError::ReceivedDataOverrun
aentinger
committed
Extracting initialisation of MQTT OTA buffer and control data for binary OTA data into separate functions
aentinger
committed
Fixing typos in order to satisfy CI spell check
aentinger
committed
The OTA out topic is not being used, therefore it can be removed from the implementation
aentinger
committed
Add GitHub Actions workflow to run unit tests and check code coverage

per1234
authored and
aentinger
committed
Add --coverage flags in CMakeLists.txt to get code coverage report data

per1234
authored and
aentinger
committed
Adding python tool for extending a binary firmware file with the length and checksum as the start as required for OTA update
aentinger
committed
Adding small README describing what bin2ota.py does and how its used
aentinger
committed
Improve board-specific configuration system in compile-examples CI workflow (#124)

per1234
authored and
aentinger
committed
Adding scripts for upload a base64 encoded OTA binary to a device
aentinger
committed
Restoring Arduino_MKRMEM as dependent library for WiFi/GSM/NB CI builds
aentinger
committed
Renaming bin2base64.py to bin2json.py in order to directly create a json object containing the base64 encoded binary because otherwise the URL becomes to long for curl to process
aentinger
committed

Commits on May 28, 2020