Overview

 Valuable statistical and diagnostic counters, reported by both OKEs and CWMs, are sent to the OKC. All the counters are 32-bit unsigned values in an ordered array that are reset to 0 when an OKE or CWM restarts. The OKE and CWM report different sets of counters that are described in this document.

ConnectWare Module Counters

 Link Layer Diagnostics

 _dll is an array of 32-bit unsigned integers that provide link layer statistical and diagnostic information about the serial communication between the CWM and the OKE. The link layer fragments OKMs into up to 4 link layer messages, so the packet counts will be greater than the number of OKMs being processed. _dll is encoded in a CWM OKM payload.

[RxCount, RxCountGood, RxCountBadCrc, TxCount, TxCountTimeout,RxCountBytes,TxCountBytes]

RxCount: The total number of possibly valid packets that received by the CWM from the OKE. RxCount = RxCountGood + RxCountBadCrc.

RxCountGood: The total number of valid packets received by the link layer.

RxCountBadCrc: The total number of packets received by the link layer with an invalid CRC.

TxCount: The total number of packets sent from the CWM to the OKE.

TxCountTimeout: The total number of times a packet sent from the CWM was not ACKed by the OKE.

RxCountBytes: Not in all implementations. Total number of bytes received.

TcCountBytes: Not in all implementations. Total number of bytes transmitted.

 Application Layer Diagnostics

 _msg is an array of 32-bit unsigned integers that provide application layer statistical and diagnostic information about OKM messages processed by the CWM.  These OKMs may be packets received from the OKE, or packets received from the OKC. _msg is encoded in a CWM OKM payload.

[RxTotal, RxNoCRC, RxBadCRC, RxRouteToOKE, RxRouteToOKC, RxNoID, RxNoCmd, RxBadCmd, RxAppCmd, RxCoreCmd, RxNoPld]

RxTotal: The total number of OKMs that the CWM has attempted to process.

RxNoCRC: The total number of messages where there was no _crc field found; the OKM was invalid and not processed.

RxBadCRC: The total number of messages where the CRC was bad; the OKM was invalid and not processed.

RxRouteToOKE: The total number of messages routed to the OKE from the OKC.

RxRouteToOKC: The total number of messages routed from the OKE to the OKC.

RxNoID: The total number of messages where there was no _id field found; the OKM was invalid and not processed.

RxNoCmd: The total number of messages where there was no _cmd field found; the OKM was invalid and not processed.

RxBadCmd: The total number of messages where there was no valid for the _cmd field found; the OKM was invalid and not processed.

RxAppCmd: The total number of valid OKM messages that were not handled by the CWM’s core command processor and sent to the Application layer processing function.

RxCoreCmd: The total number of valid OKM messages that were handled by the CWM’s core command processor.

RxNoPld: The total number of messages where there was no _pld field; the OKM was invalid and not processed.

Heartbeat Layer Diagnostics

_hbt.diag is an array of 5 unsigned 32-bit integers followed by 4 unsigned 16-bit integers reporting high level application layer diagnostics on the CWM’s heartbeat.

[RecordTotal, RecordNoCRC, RecordBadCRC, RecordBadJSON, RecordBadRecord, OverrunSphere, OverrunTTL, Overrun232, Overrun485]

RecordTotal: Total attempts to read a telemetry or priority record.

RecordNoCRC: Total read records with valid JSON, but no CRC field.

RecordBadCRC: Total read records with valid JSON, but CRC failed check.

RecordBadJSON: Total read records with invalid JSON.

RecordBadRecord: Total read records where record bookkeeping was not valid.

OverrunSphere: Total number of serial overrun errors on PIC to Sphere serial interface.

OverrunTTL: Total number of serial overrun errors on TTL CWM to OKE serial interface.

Overrun232: Total number of serial overrun errors on RS232 CWM to OKE serial interface.

Overrun485: Total number of serial overrun errors on RS485  CWM to OKE serial interface.

Network Layer Diagnostics

diag is an array of 32-bit unsigned integers that provide network layer statistical and diagnostic information about the CWM’s network connection and operation. diag is reported in the push request outside of the OKM envelope.

[LED_TX_STATE, LED_RX_STATE, LED_NOT_OK_STATE, LED_UNBOUND_STATE, LED_IDLE_STATE, IDLE_PULL_STATE, PULL_REQ, PULL_STATE, PULL_ONE, PULL_MANY, PULL_DELAY_STATE, PUSH_IDLE_STATE, PUSH_REQ, PUSH_STATE, PUSH_OK, PUSH_FAILED, PROV_SAP_WAIT_STATE, PROV_SAP_IDLE_STATE, PROV_SAP_REQ_STATE, PROV_SAP_REQ, PROV_IDLE_STATE, PROV_REQ, PROV_REQ_STATE, PROV_REQ_STORED, SCAN_REQ, SCAN_STATE, SAP_OPEN_STATE, IDLE_STATE]

LED_TX_STATE: Net status LED blinks green due to TX from CWM.

LED_RX_STATE: Net status LED blinks red due to RX from OKC.

LED_NOT_OK_STATE: Net status LED solid red due to network error.

LED_UNBOUND_STATE: Net status LED solid orange to indicate unbound.

LED_IDLE_STATE: Net status LED off.

IDLE_PULL_STATE: Waiting for pull operation to be requested.

PULL_REQ: Request to pull occurred.

PULL_STATE: Waiting for pull response.

PULL_ONE: One OKM was pulled.

PULL_MANY: An array of OKMs was pulled.

PULL_DELAY_STATE: Pull delay.

PUSH_IDLE_STATE: Waiting for push to be required.

PUSH_REQ: Push request made.

PUSH_STATE: Waiting for push response.

PUSH_OK: Push was successful

PUSH_FAILED: Push failed.

PROV_SAP_WAIT_STATE: Waiting to provision SAP.

PROV_SAP_IDLE_STATE: Monitoring SAP provisioning.

PROV_SAP_REQ_STATE: Made SAP provision request.

PROV_SAP_REQ: Waiting for SAP provision response.

PROV_IDLE_STATE: Monitoring for CWM provisioning.

PROV_REQ: Request for CWM provisioning.

PROV_REQ_STATE: Waiting for CWM provisioning response.

PROV_REQ_STORED: Stored CWM provisioning.

SCAN_REQ: Request to scan for WiFi networks.

SCAN_STATE: Handling scan.

SAP_OPEN_STATE: Trying to connect to SAP open network.

IDLE_STATE: Monitoring network status.

OpenKitchen Equipment Counters

Link Layer Diagnostics

_dll is an array of 32-bit unsigned integers that provide link layer statistical and diagnostic information about the serial communication between the OKE and the CWM. The link layer fragments OKMs into up to 4 link layer messages, so the packet counts will be greater than the number of OKMs being processed. _dll is encoded in an OKE OKM payload.

[RxCount, RxCountGood, RxCountBadCrc, TxCount, TxCountTimeout, RxCountBytes, TxCountBytes]

RxCount: The total number of possibly valid packets that received by the OKE from the CWM. RxCount = RxCountGood + RxCountBadCrc.

RxCountGood: The total number of valid packets received by the link layer.

RxCountBadCrc: The total number of packets received by the link layer with an invalid CRC.

TxCount: The total number of packets sent from the OKE to the CWM.

TxCountTimeout: The total number of times a packet sent from the OKE was not ACKed by the CWM.

RxCountBytes: The total number of bytes received by the OKE.

TxCountBytes: The total number of bytes transmitted by the OKE.

Heartbeat Diagnostics

When an OKE generates a heartbeat message that exceeds a size warning threshold, the core library heartbeat data will contain _hbw and _hbm fields. _hbw is a Boolean indicating that a size warning occurred, and _hbm is the maximum allowed heartbeat size.

When an OKE heartbeat exceeds the warning threshold it may indicate that the OKE might exceed the hard size limit if the heartbeat size continues to increase. If the hard limit is exceeded then the CWL will generate an empty heartbeat {}.