Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: Add support for UART devices #493

Merged
merged 58 commits into from
Oct 2, 2023
Merged

Feature: Add support for UART devices #493

merged 58 commits into from
Oct 2, 2023

Conversation

brentru
Copy link
Member

@brentru brentru commented Sep 19, 2023 •
edited
Loading

This pull request adds initial WipperSnapper support for UART devices.

Technical notes:

  • Initial support for the PMS5003 Air Quality Sensor is included with this PR, with more sensors down the line
  • WipperSnapper defaults to using the hardware UART bus unless the BSP includes a copy of SoftwareSerial.

Implementation notes:

  • Unlike I2C, UART devices share a common period
  • Unlike I2C drivers, UART drivers publish data out to IO

Other notes:

  • Fixed: ESP32 platforms not connecting to IO-Staging Server

Tests:
Hardware UART

  • Create a UART device from Adafruit.io
  • Delete a UART device from Adafruit.io
  • Update a UART device's period from Adafruit.io
  • Update the number of a UART device's sensor "sub-components" from Adafruit.io
  • Verification that UART devices send data at a consistent period
  • Re-sync a UART device

Software UART

  • Create a UART device from Adafruit.io
  • Delete a UART device from Adafruit.io
  • Update a UART device's period from Adafruit.io
  • Update the number of a UART device's sensor "sub-components" from Adafruit.io
  • Verification that UART devices send data at a consistent period
  • Re-sync a UART device

Resolves #359

brentru added 30 commits July 25, 2023 14:28
@brentru
signals match f2f6ff8
850ca1e
@brentru
hooks for topics
2f7d2d5
@brentru
decoder and match commit
3a11dd9
@brentru
match latest uart PR with refactored init sequence
8890f19
@brentru
add uart skel.
74d3c33
@brentru
sync ws proto commit 2e9136f
615615a
@brentru
include ws_uart, hw serial init
f61bc02
@brentru
compile
4b45546
@brentru
add uart driver base:
0af7867
@brentru
add pm25aqi class mock using base
69614d1
@brentru
rename
ae3f258
@brentru
inclusion of hwserial and swserial in driver, notes for Friday
daea7dd
@brentru
driver begin()
28462e2
@brentru
working on begin() for drivers
1a9975a
@brentru
properly attach uart device and publish response back via hook
eb9fab9
@brentru
add begin, switch around logging msgs
44781c0
@brentru
passing mqtt client in, read uart sensor
7d243ce
@brentru
match 0b49845c972f37c5e26e15b0713266d750864e82
f1ca518
@brentru
match a7b14abeacee98c2b0f2750468c27853f55d56bc
1cdfaef
@brentru
change payload name for new proto
45dc6f8
@brentru
add message encoding, publishing, new data_available getter
2e54ee8
@brentru
write update()
ce20afd
@brentru
doxygen cleanup
2892455
@brentru
init. uart class in ws.cpp, split uart bus init into two functions
31ca579
@brentru
Merge branch 'main' of github.com:adafruit/Adafruit_Wippersnapper_Ard…
2b4317f 
…uino into add-uart-feature
@brentru
complete merge, annotate a breaking change with the new protobufs
f7318b2
@brentru
refactor update even more
805e43c
@brentru
add uart detach
11bec50
@brentru
safely iterate through the vector of drivers and deallocate memory
a666bd7
@brentru
working on staging
6f855cf
tyeth
tyeth reviewed Sep 21, 2023
View reviewed changes
src/Wippersnapper.cpp Outdated Show resolved Hide resolved
tyeth
tyeth reviewed Sep 21, 2023
View reviewed changes
src/Wippersnapper.cpp Outdated Show resolved Hide resolved
@brentru brentru marked this pull request as ready for review September 26, 2023 19:08
@brentru brentru requested a review from tyeth September 26, 2023 19:33
@brentru
Copy link
Member Author

brentru commented Sep 26, 2023

@tyeth Could you re-review this again at some point this week?

@brentru
Copy link
Member Author

brentru commented Sep 27, 2023 •
edited
Loading

✅ Tested on hardware across all platforms except RP2040/PicoW due to WiFi issues
✅ Self-reviewed the PR

tyeth
tyeth approved these changes Oct 2, 2023
View reviewed changes
Copy link
Contributor

@tyeth tyeth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Driver name to pms5003 would be nice, but not fussed.

src/components/uart/drivers/ws_uart_drv_pm25aqi.h Outdated Show resolved Hide resolved
src/components/uart/ws_uart.cpp Outdated Show resolved Hide resolved
src/components/uart/ws_uart.cpp Show resolved Hide resolved
@brentru brentru merged commit bd8a96a into adafruit:main Oct 2, 2023
24 checks passed
@brentru brentru deleted the add-uart-feature branch October 2, 2023 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tyeth tyeth tyeth approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request uart
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support UART Air Quality Sensors
2 participants
@brentru @tyeth