ArduinoCloudTCP: Separate the logic of the device and the logic of the thing in two different state machines #425
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #425 +/- ##
=======================================
Coverage 95.00% 95.00%
=======================================
Files 27 27
Lines 1221 1221
=======================================
Hits 1160 1160
Misses 61 61 ☔ View full report in Codecov by Sentry. |
|
Memory usage change @ e745256
Click for full report table
Click for full report CSV |
mirkokurt
force-pushed
the
mirkokurt/arduino-iot-infra
branch
from
8b8e483 to
5675efc
Compare
|
|
||
| #ifndef ARDUINO_AIOTC_TYPES_H_ | ||
| #define ARDUINO_AIOTC_TYPES_H_ | ||
|
|
There was a problem hiding this comment.
Suggested change
| #include <stdint.h> | |
| TYPEDEF | ||
| ******************************************************************************/ | ||
|
|
||
| typedef enum |
There was a problem hiding this comment.
Suggested change
| typedef enum | |
| typedef enum: uint8_t |
We don't need and entire int32 to represent the R/W modes
|
Memory usage change @ 63ff024
Click for full report table
Click for full report CSV |
per1234
added
type: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to separate the logic of the device (connect to the physical network, connect to MQTT, connect to device topics...) from the logic of the thing (receive the thing id, connect to the thing topics, sync and send telemetry) splitting the whole connection logic in two different state machines.
To achieve this, a new ArduinoIoTCloudTCPThing class has been created as member of the ArduinoIoTCloudTCP class.
The new class implement a state machine dedicated to the thing logic. The device logic has been kept in the ArduinoIoTCloudTCP.
From the user perspective, the only difference is that now the device state machine is not blocked anymore waiting the thing id when the thing id is not provided by the backend. The device state machine is independent from the thing configuration and, theoretically, is able to perform an OTA even if not attached to a thing (theoretically because the backend does not allow this).
From the developer perspective, this refactor allows a better logical separation of behaviours, improved readability and maintainability, and it's preparatory to future enhancements of the OTA feature.