Diff: protocol.h

Revision:

0:aca5a32d2759

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/protocol.h	Fri Mar 18 22:33:32 2016 +0000
@@ -0,0 +1,55 @@
+/**
+ * Telemetry wire protocol constants.
+ */
+
+#ifndef _PROTOCOL_H_
+#define _PROTOCOL_H_
+
+namespace telemetry {
+
+namespace protocol {
+
+// Start of frame sequence.
+const uint8_t SOF_SEQ[] = {0x05, 0x39};
+const uint8_t SOF_LENGTH = sizeof(SOF_SEQ) / sizeof(SOF_SEQ[0]);
+// A dummy byte to "stuff" when the start of frame shows up in the data.
+const uint8_t SOF_SEQ0_STUFF = 0x00;
+
+const size_t LENGTH_SIZE = 2;
+
+// TODO: make these length independent
+
+const uint8_t OPCODE_HEADER = 0x81;
+const uint8_t OPCODE_DATA = 0x01;
+
+const uint8_t DATAID_TERMINATOR = 0x00;
+
+const uint8_t DATATYPE_NUMERIC = 0x01;
+const uint8_t DATATYPE_NUMERIC_ARRAY = 0x02;
+
+const uint8_t RECORDID_TERMINATOR = 0x00;
+const uint8_t RECORDID_INTERNAL_NAME = 0x01;
+const uint8_t RECORDID_DISPLAY_NAME = 0x02;
+const uint8_t RECORDID_UNITS = 0x03;
+
+const uint8_t RECORDID_OVERRIDE_CTL = 0x08;
+const uint8_t RECORDID_OVERRIDE_DATA = 0x08;
+
+const uint8_t RECORDID_NUMERIC_SUBTYPE = 0x40;
+const uint8_t RECORDID_NUMERIC_LENGTH = 0x41;
+const uint8_t RECORDID_NUMERIC_LIMITS = 0x42;
+const uint8_t RECORDID_ARRAY_COUNT = 0x50;
+
+const uint8_t NUMERIC_SUBTYPE_UINT = 0x01;
+const uint8_t NUMERIC_SUBTYPE_SINT = 0x02;
+const uint8_t NUMERIC_SUBTYPE_FLOAT = 0x03;
+
+/**
+ * Returns the subtype field value for a numeric recordid.
+ */
+template<typename T> uint8_t numeric_subtype();
+}
+
+}
+
+#endif