Skip to content

API V2#133

Open
brentru wants to merge 364 commits intomasterfrom
api-v2
Open

API V2#133
brentru wants to merge 364 commits intomasterfrom
api-v2

Conversation

@brentru
Copy link
Copy Markdown
Member

@brentru brentru commented Nov 9, 2023

WipperSnapper API V2 aims to address:

  • Enforce consistent naming of messages and fields
  • Reduce the amount of MQTT topics utilized by WipperSnapper from >25 to 1 bi-directional topic, signal
  • Implement a unified sensor API, sensor.proto
  • Refactor pin.proto into analogio.proto and analogio.proto
  • Possible: Move to period-per-component (vs -per-sensor)

@brentru brentru requested review from lorennorman and tyeth November 9, 2023 19:09
Copy link
Copy Markdown
Contributor

@lorennorman lorennorman left a comment

Choose a reason for hiding this comment

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

This is all just really great! I had lots of notes reading through this but overall it's an obviously-better direction, better organized, more bang-for-buck, easier and more performant to implement in code.

Comment thread proto/wippersnapper/description/v1/description.proto Outdated
Comment thread proto/wippersnapper/description/v1/description.proto Outdated
Comment thread proto/wippersnapper/i2c/v1/i2c.proto Outdated
Comment thread proto/wippersnapper/pixels/v1/pixels.proto Outdated
Comment thread proto/wippersnapper/pwm/v1/pwm.proto Outdated
Comment thread proto/wippersnapper/signal/v1/signal.proto Outdated
Comment thread proto/wippersnapper/signal/v1/signal.proto Outdated
Comment thread proto/wippersnapper/i2c/v1/i2c.proto Outdated
Comment thread proto/wippersnapper/signal/v1/signal.proto Outdated
Comment thread proto/wippersnapper/signal/v1/signal.proto Outdated
Copy link
Copy Markdown

@PetteriAimonen PetteriAimonen left a comment

Choose a reason for hiding this comment

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

Overall, looks reasonable. I'd consider removing the deprecated fields completely at this point, as you are making such large API changes that no existing code will be compatible anyway.

Comment thread proto/wippersnapper/analogio/v1/analogio.proto Outdated
Comment thread proto/wippersnapper/analogio/v1/analogio.proto Outdated
Comment thread proto/wippersnapper/digitalio/v1/digitalio.proto Outdated
Comment thread proto/wippersnapper/digitalio/v1/digitalio.proto Outdated
Comment thread proto/wippersnapper/ds18x20/v1/ds18x20.proto Outdated
Comment thread proto/wippersnapper/sensor/v1/sensor.proto Outdated
Comment thread proto/wippersnapper/servo/v1/servo.proto
Comment thread proto/wippersnapper/signal/v1/signal.proto Outdated
Comment thread proto/wippersnapper/signal/v1/signal.proto Outdated
Comment thread proto/wippersnapper/uart/v1/uart.proto Outdated
@brentru brentru added the v2 label Mar 16, 2026
@tyeth tyeth removed their request for review April 3, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants