Introducing typetags to support WiFi creds over serial by nitin710 · Pull Request #25 · EmotiBit/EmotiBit_XPlat_Utils

nitin710 · 2023-09-14T14:43:21Z

Description

Adds typetags to enable updating WiFi creds over serial
Adds EmotiBitSerial class
- Supporting functions to send and parse messages over serial

Requirements

None

Issues Referenced

None

Documentation update

None

Notes for Reviewer

None

Testing

Check Feat WiFi creds over serial EmotiBit_FeatherWing#283

Checklist to allow merge

All dependent repositories used were on branch master
Firmware
- Set testingMode to TestingMode::NONE
- Set const bool DIGITAL_WRITE_DEBUG = false (if set true while testing)
- Update version in EmotiBit.h
- Update library.properties to the correct version (should match EmotiBit.h)
doxygen style comments included for new code snippets
Required documentation updated

Screenshots:

produceconsumerobot

@nitin710 code review complete

produceconsumerobot · 2024-03-14T17:43:42Z

src/EmotiBitSerial.h

+#include <Arduino.h>
+#endif
+
+class EmotiBitSerial


We should have the serial messages 'R', 'C', 'D' 'F', etc defined here so that there is a single source of truth instead of magic chars everywhere.

Added Inputs

struct Inputs { static const char RESET = 'R'; static const char CONFIG_UPDATE = 'C'; static const char DEBUG_MODE = 'D'; static const char FACTORY_TEST_MODE = 'F'; };

produceconsumerobot · 2024-03-14T17:48:50Z

src/EmotiBitSerial.cpp

+	return true;
+}
+
+void EmotiBitSerial::sendMessage(String typeTag, String payload)


is EmotiBitSerial::sendMessage essentially just a replica of EmotiBitFactoryTest::sendMessage ?

Perhaps we should use the EmotiBitFactoryTest::sendMessage code here and call EmotiBitSerial::sendMessage from EmotiBitFactoryTest::sendMessage?

Moved guts of EmotiBitFactoryTest::sendMessage into EmotiBitSerial::sendMessage and made a pass through call in EmotiBitFactoryTest::sendMessage

produceconsumerobot · 2024-03-14T18:03:44Z

src/EmotiBitSerial.h

+    static void sendMessage(String typeTag, String payload = "");
+
+#endif
+    static const char MSG_START_CHAR = '@';


MSG_START_CHAR and other vars are now a multiple source of truth with EmotiBitFactoryTest vars of same name

Removed it from Factory test. It now only exists in EmotiBitSerial

produceconsumerobot · 2024-03-14T18:08:45Z

src/EmotiBitSerial.cpp

+	{
+		int payloadDelimiterIndex = message.indexOf(PAYLOAD_DELIMITER);
+		int messageDelimiterIndex = message.indexOf(MSG_TERM_CHAR);
+		if (payloadDelimiterIndex > 0 && messageDelimiterIndex > 0)


Perhaps we should also check that messageDelimiterIndex > payloadDelimiterIndex +1?
or +2 if we don't want to accept an empty string payload

I was iffy about implementing the +2 (for the empty string test). But, after thinking about it, I added it.
Reason being, if we have 1 space, it can be unintentional, but if its more than a space, the user probably meant it.

So I added both checks.

produceconsumerobot · 2024-03-14T18:18:55Z

src/EmotiBitSerial.cpp

+#include "EmotiBitSerial.h"
+
+#ifdef ARDUINO
+bool EmotiBitSerial::parseSerialMessage(String message, String &typetag, String &payload)


Shouldn't this function be able to handle typetag-only messages with no payload, e.g. like many messages processed in EmotiBit::processFactoryTestMessages()?

Added that functionality.
We can now enter only Typetags

nitin710 · 2024-03-21T13:54:27Z

Made changes as per review.
Some test results

@TT, PL~ : TEST-PASS
TT, payload : TEST-PASS
@TT, payload : TEST-PASS
@TT,~ : TEST-PASS
@TT, ~ : TEST-PASS
@TT~ : TEST-PASS
@TT,  ~ : TEST-PASS

jaemindev and others added 2 commits August 31, 2023 14:40

Created Type tags for sd card packets.

fd787db

support for adding WiFi creds through serial

ccb2640

nitin710 mentioned this pull request Sep 14, 2023

Feat WiFi creds over serial EmotiBit/EmotiBit_FeatherWing#283

Merged

7 tasks

nitin710 added 3 commits September 14, 2023 10:50

removing extra reset typetag

79f648e

Added list packet

5d5fb17

minor comments and todo.

28995bf

produceconsumerobot requested changes Mar 14, 2024

View reviewed changes

changes as per review

115d237

nitin710 added 5 commits March 21, 2024 09:57

some additional comments

04a9fd7

added input option for adc correction mode

61ae0b9

modified name of Input-Config update to Input-cred update

a4386de

Fix in logic.

6258ba6

version bump to 1.6.0. features emotibit serial

4e9cd75

nitin710 merged commit af7e2f3 into master Mar 26, 2024

nitin710 deleted the feat-newTagsForSd branch March 26, 2024 17:02

Conversation

nitin710 commented Sep 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Requirements

Issues Referenced

Documentation update

Notes for Reviewer

Testing

Checklist to allow merge

Screenshots:

Uh oh!

produceconsumerobot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nitin710 commented Mar 21, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nitin710 commented Sep 14, 2023 •

edited

Loading