adafruit-mirror/Wippersnapper_Protobuf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

switch from uint to string, update docs

Browse source
This commit is contained in:
brentru 2023-08-28 16:55:38 -04:00
parent 6dac52f0ce
commit 82718889c7
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
proto/wippersnapper/uart/v1/uart.md
View file

@ -5,7 +5,7 @@ This file details the WipperSnapper messaging API for interfacing with a UART bu
## WipperSnapper Components
The following WipperSnapper components utilize `pwm.proto`:
The following WipperSnapper components utilize `uart.proto`:
* PMS* Air Quality Sensors
* Adafruit Universal GPS module using the MTK33x9 chipset

6
proto/wippersnapper/uart/v1/uart.proto
View file

@ -12,8 +12,8 @@ import "wippersnapper/i2c/v1/i2c.proto";
*/
message UARTBusData {
int32 baudrate = 1; /** The baudrate to use for UART communication (may be a common baud rate such as: 1200bps, 2400bps, 4800bps, 19200bps, 38400bps, 57600bps, or 115200bps). */
int32 pin_rx = 2; /** The pin on which to receive UART stream data. */
int32 pin_tx = 3; /** The pin on which to transmit UART stream data. */
string pin_rx = 2[(nanopb).max_size = 6]; /** The pin on which to receive UART stream data. */
string pin_tx = 3[(nanopb).max_size = 6]; /** The pin on which to transmit UART stream data. */
bool is_invert = 4; /** Inverts the UART signal on RX and TX pins. Defaults to False. */
}
@ -38,7 +38,7 @@ message UARTDeviceAttachResponse {
/**
* UARTDeviceEvent represents incoming data from a UART sensor.
*/
*
message UARTDeviceEvent {
string device_id = 1[(nanopb).max_size = 15]; /** The unique identifier of the device to attach to the UART bus, from Adafruit_WipperSnapper_Components. */
repeated wippersnapper.i2c.v1.SensorEvent sensor_event = 2[(nanopb).max_count = 15]; /** A, optionally repeated, SensorEvent from a sensor. */