Device Errors Format

Ronan · March 27, 2024, 1:25pm

Hi,

I am using the REST api call “get /api/devices/{dev_eui}/stats” which has an “errors” response field. The documentation shows the format as an empty object {} and the model description is “inline_model_2, optional): Error count.” .

As it is difficult to create a Device error for testing purposes can anyone describe what format i should receive here if an error existed? Is it a key:value pair with the key being a server reponse code and then a string description for the value? Also, i’m not sure what the significance of “inline_model_2” is?

Thanks!

Ronan · March 28, 2024, 9:30am

I found an example of how the error reponse is formatted:

“errors”: {
“OTAA”: 1
}

So it looks like a key value pair with the key being the error type and the value being a count for this type.

bconway · March 28, 2024, 12:45pm

It appears you are using ChirpStack v3, please include that in the future. I think these are the ones you want:

github.com

brocaar/chirpstack-api/blob/8ffcaa7b274e83f67d18adfe1b5264fedbc8b385/protobuf/as/external/api/device.proto#L420


      
          message GetRandomDevAddrRequest {
              // Device EUI (HEX encoded).
              string dev_eui = 1 [json_name = "devEUI"];
          }
          
          message GetRandomDevAddrResponse {
              // Device address (HEX encoded).
              string dev_addr = 1;
          }
          
          message DeviceStats {
          	// Timestamp of the (aggregated) measurement.
          	google.protobuf.Timestamp timestamp = 1;
          
              // Packets received from the device.
              uint32 rx_packets = 2;
          
              // Average RSSI (as reported by the gateway(s)).
              float gw_rssi = 3;
          
              // Average SNR (as reported by the gateway(s)).

github.com

brocaar/chirpstack-api/blob/8ffcaa7b274e83f67d18adfe1b5264fedbc8b385/protobuf/as/as.proto#L58


      
              // Note there is no requirement that the number of returned items must be
              // equal to the number of requested items.
              rpc ReEncryptDeviceQueueItems(ReEncryptDeviceQueueItemsRequest) returns (ReEncryptDeviceQueueItemsResponse) {}
          }
          
          enum RXWindow {
              RX1 = 0;
              RX2 = 1;
          }
          
          enum ErrorType {
              // Generic error type.
              GENERIC = 0;
          
              // OTAA error.
              OTAA = 1;
          
              // Uplink frame-counter was reset.
              DATA_UP_FCNT_RESET = 2;
          
              // Uplink MIC error.

Ronan · March 28, 2024, 3:38pm

Thanks for the info. Also, do you know if rxPackets includes errored packets in its count? I want to work out the percentage errors.

bconway · March 28, 2024, 3:49pm

There’s a lot of good info in the gateway Stats payloads, check the proto definition. I’m mostly living in v4 today.