API V2 #133
API V2 #133
Conversation
| @@ -10,36 +10,20 @@ import "nanopb/nanopb.proto"; | |||
| * CreateDescriptionRequest identifies a device with Adafruit.io WipperSnapper. | |||
| */ | |||
| message CreateDescriptionRequest { | |||
There was a problem hiding this comment.
I'd like to get to something better than "description" before we're done. Not sure what right now, depends whether we drop the response part. If it's just checking in with your Semver, maybe "checkin" or something.
| */ | ||
| message CreateDescriptionResponse { | ||
| message CreateDescription { | ||
| Response response = 1; /** Specifies if the hardware definition exists on the server. */ |
There was a problem hiding this comment.
Noticing the "response" part, I guess even if we wanted to do away with this response entirely, we'd need a way to signal that the checkin failed in this way (board lookup failed). Maybe that's another Error message type and the broker can just send that.
proto/wippersnapper/i2c/v1/i2c.proto
Outdated
There was a problem hiding this comment.
I2C is still so massive and complex! I have a lingering feeling that there's more useful refactoring to do here if we focus on it, perhaps during implementation or an early investigative spike.
There was a problem hiding this comment.
👍 Keeping this conversation open as a reminder
| //digitalio.proto | ||
| wippersnapper.digitalio.v1.DigitalIOEvent digitalio_event = 1; | ||
| // analogio.proto | ||
| wippersnapper.analogio.v1.AnalogIOEvent analogio_event = 2; |
There was a problem hiding this comment.
Are we avoiding an *Added event for io components? I forget if we talked about that.
There was a problem hiding this comment.
I am not sure, what are your thoughts?
There was a problem hiding this comment.
I don't know the hardware side of course, but if you can definitely tell if you've successfully connected the selected component, then yeah I'd advocate we have AnalogIOAdded and DigitalIOAdded messages to fit the pattern and improve user experience.
There was a problem hiding this comment.
@lorennorman To clarify here - we want a new message called AnalogIOAdded. We are not changing AnalogIOAdd to AnalogIOAdded`.
…strip nanopb dep off the rest
… I2cDeviceDescriptor
WipperSnapper API V2 aims to address:
signalsensor.protopin.protointoanalogio.protoandanalogio.proto