Rename protocol address enum to priority

arduino/common/lib/CommsControl/CommsCommon.h

@@ -40,11 +40,11 @@
 #define PACKET_SET   0x20 //set vs get ?
 
 // enum of all transfer types
-enum PAYLOAD_TYPE {
-    DATA,
-    CMD,
-    ALARM,
-    UNSET
+enum PRIORITY {
+    DATA  = PACKET_DATA,
+    CMD   = PACKET_CMD,
+    ALARM = PACKET_ALARM,
+    UNSET = 0x00
 };
 
 // payload consists of type and information
@@ -52,7 +52,7 @@ enum PAYLOAD_TYPE {
 // information is set as information in the protocol
 class Payload {
 public:
-    Payload(PAYLOAD_TYPE type = PAYLOAD_TYPE::UNSET)  {_type = type; }
+    Payload(PRIORITY type = PRIORITY::UNSET)  {_type = type; }
     Payload(const Payload &other) {
         _type = other._type;
         _size = other._size;
@@ -66,15 +66,15 @@ public:
     }
 
     ~Payload() { unset(); }
-    void unset() { memset( _buffer, 0, PAYLOAD_MAX_SIZE_BUFFER); _type = PAYLOAD_TYPE::UNSET; _size = 0;}
+    void unset() { memset( _buffer, 0, PAYLOAD_MAX_SIZE_BUFFER); _type = PRIORITY::UNSET; _size = 0;}
 
-    void setType(PAYLOAD_TYPE type) { _type = type; }
-    PAYLOAD_TYPE getType() {return _type; }
+    void setType(PRIORITY type) { _type = type; }
+    PRIORITY getType() {return _type; }
 
     void setSize(uint8_t size) { _size = size; }
     uint8_t getSize() { return _size; }
 
-    bool setPayload(PAYLOAD_TYPE type, void* information, uint8_t size) {
+    bool setPayload(PRIORITY type, void* information, uint8_t size) {
         if (information == nullptr) {
             return false;
         }
@@ -87,12 +87,12 @@ public:
     }
 
     bool getPayload(void* information) {
-        PAYLOAD_TYPE type;
+        PRIORITY type;
         uint8_t size;
         return getPayload(information, type, size);
     }
 
-    bool getPayload(void* information, PAYLOAD_TYPE &type, uint8_t &size) {
+    bool getPayload(void* information, PRIORITY &type, uint8_t &size) {
         if (information == nullptr) {
             return false;
         }
@@ -108,7 +108,7 @@ public:
     void *getInformation() { return reinterpret_cast<void*>(_buffer); }
 
 private:
-    PAYLOAD_TYPE _type;
+    PRIORITY _type;
     uint8_t      _buffer[PAYLOAD_MAX_SIZE_BUFFER];
     uint8_t      _size;
 };

arduino/common/lib/CommsControl/CommsControl.cpp

@@ -88,7 +88,7 @@ void CommsControl::receiver() {
                             uint8_t address = *_comms_tmp.getAddress();
 
                             // to decide what kind of packets received
-                            PAYLOAD_TYPE type = getInfoType(address);
+                            PRIORITY type = getInfoType(address);
 
                             // switch on received data to know what to do - received ACK/NACK or other
                             switch(control & COMMS_CONTROL_TYPES) {
@@ -136,8 +136,8 @@ void CommsControl::receiver() {
 }
 
 bool CommsControl::writePayload(Payload &pl) {
-    PAYLOAD_TYPE payload_type = pl.getType();
-    if (payload_type != PAYLOAD_TYPE::UNSET) {
+    PRIORITY payload_type = pl.getType();
+    if (payload_type != PRIORITY::UNSET) {
         // create comms format using payload, the type is deduced from the payload itself
         CommsFormat comms = CommsFormat(pl);
 
@@ -243,7 +243,7 @@ void CommsControl::resendPacket(RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING>
 
 
 // receiving anything of commsFormat
-bool CommsControl::receivePacket(PAYLOAD_TYPE &type) {
+bool CommsControl::receivePacket(PRIORITY &type) {
     _payload_tmp.unset();
     _payload_tmp.setPayload(type, reinterpret_cast<void *>(_comms_tmp.getInformation()), _comms_tmp.getInfoSize());
 
@@ -258,7 +258,7 @@ bool CommsControl::receivePacket(PAYLOAD_TYPE &type) {
 }
 
 // if FCS is ok, remove from queue
-void CommsControl::finishPacket(PAYLOAD_TYPE &type) {
+void CommsControl::finishPacket(PRIORITY &type) {
     RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING> *queue = getQueue(type);
 
     if (queue != nullptr && !queue->isEmpty()) {
@@ -274,27 +274,27 @@ void CommsControl::finishPacket(PAYLOAD_TYPE &type) {
     }
 }
 
-PAYLOAD_TYPE CommsControl::getInfoType(uint8_t &address) {
+PRIORITY CommsControl::getInfoType(uint8_t &address) {
     switch (address & PACKET_TYPE) {
         case PACKET_ALARM:
-            return PAYLOAD_TYPE::ALARM;
+            return PRIORITY::ALARM;
         case PACKET_CMD:
-            return PAYLOAD_TYPE::CMD;
+            return PRIORITY::CMD;
         case PACKET_DATA:
-            return PAYLOAD_TYPE::DATA;
+            return PRIORITY::DATA;
         default:
-            return PAYLOAD_TYPE::UNSET;
+            return PRIORITY::UNSET;
     }
 }
 
 // get link to queue according to packet format
-RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING> *CommsControl::getQueue(PAYLOAD_TYPE &type) {
+RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING> *CommsControl::getQueue(PRIORITY &type) {
     switch (type) {
-        case PAYLOAD_TYPE::ALARM:
+        case PRIORITY::ALARM:
             return &_ring_buff_alarm;
-        case PAYLOAD_TYPE::CMD:
+        case PRIORITY::CMD:
             return &_ring_buff_cmd;
-        case PAYLOAD_TYPE::DATA:
+        case PRIORITY::DATA:
             return &_ring_buff_data;
         default:
             return nullptr;

arduino/common/lib/CommsControl/CommsControl.h

@@ -26,13 +26,13 @@ public:
     void receiver();
 
 private:
-    RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING> *getQueue(PAYLOAD_TYPE &type);
-    PAYLOAD_TYPE getInfoType(uint8_t &address);
+    RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING> *getQueue(PRIORITY &type);
+    PRIORITY getInfoType(uint8_t &address);
 
     void sendQueue    (RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING> *queue);
     void resendPacket (RingBuf<CommsFormat, COMMS_MAX_SIZE_RB_SENDING> *queue);
-    bool receivePacket(PAYLOAD_TYPE &type);
-    void finishPacket (PAYLOAD_TYPE &type);
+    bool receivePacket(PRIORITY &type);
+    void finishPacket (PRIORITY &type);
 
     bool encoder(uint8_t* payload, uint8_t data_size);
     bool decoder(uint8_t* payload, uint8_t dataStart, uint8_t data_stop);

arduino/common/lib/CommsControl/CommsFormat.cpp

@@ -8,13 +8,13 @@ CommsFormat::CommsFormat(uint8_t info_size, uint8_t address, uint16_t control) {
 CommsFormat::CommsFormat(Payload &pl) {
     uint8_t address;
     switch (pl.getType()) {
-        case PAYLOAD_TYPE::ALARM:
+        case PRIORITY::ALARM:
             address = PACKET_ALARM;
             break;
-        case PAYLOAD_TYPE::CMD:
+        case PRIORITY::CMD:
             address = PACKET_CMD;
             break;
-        case PAYLOAD_TYPE::DATA:
+        case PRIORITY::DATA:
             address = PACKET_DATA;
             break;
         default:

arduino/hev_prototype_v1/src/UILoop.cpp

@@ -25,7 +25,7 @@ void UILoop::receiveCommands()
     // check any received payload
     if(_comms->readPayload(_plReceive)) {
 
-      if (_plReceive.getType() == PAYLOAD_TYPE::CMD) {
+      if (_plReceive.getType() == PRIORITY::CMD) {
           // apply received cmd to ui loop
           cmd_format cmd;
           _plReceive.getPayload(reinterpret_cast<void*>(&cmd));
@@ -33,7 +33,7 @@ void UILoop::receiveCommands()
       }
 
       // unset received type not to read it again
-      _plReceive.setType(PAYLOAD_TYPE::UNSET);
+      _plReceive.setType(PRIORITY::UNSET);
     }
 }
 
@@ -56,7 +56,7 @@ void UILoop::reportFastReadings()
         _fast_data.pressure_o2_regulated = readings_avgs.pressure_o2_regulated;
         _fast_data.pressure_diff_patient = readings_avgs.pressure_diff_patient;
 
-        _plSend.setPayload(PAYLOAD_TYPE::DATA, reinterpret_cast<void *>(&_fast_data), sizeof(_fast_data));
+        _plSend.setPayload(PRIORITY::DATA, reinterpret_cast<void *>(&_fast_data), sizeof(_fast_data));
         _comms->writePayload(_plSend);
         _fast_report_time = tnow;
     }
@@ -107,7 +107,7 @@ void UILoop::reportReadbackValues()
         // _readback_data.peep = _breathing_loop->peep();
         _readback_data.inhale_exhale_ratio = _breathing_loop->getIERatio();
 
-        _plSend.setPayload(PAYLOAD_TYPE::DATA, reinterpret_cast<void *>(&_readback_data), sizeof(_readback_data));
+        _plSend.setPayload(PRIORITY::DATA, reinterpret_cast<void *>(&_readback_data), sizeof(_readback_data));
         _comms->writePayload(_plSend);
         _readback_report_time = tnow;
     }
@@ -121,7 +121,7 @@ void UILoop::reportCycleReadings()
 
         _cycle_data.timestamp =  tnow;
 
-        _plSend.setPayload(PAYLOAD_TYPE::DATA, reinterpret_cast<void *>(&_cycle_data), sizeof(_cycle_data));
+        _plSend.setPayload(PRIORITY::DATA, reinterpret_cast<void *>(&_cycle_data), sizeof(_cycle_data));
         _comms->writePayload(_plSend);
         _cycle_report_time = tnow;
     }