Merge pull request #7048 from TheThingsNetwork/feature/4205-per

Emit Packet Error Rate as part of the uplink messages
TheThingsNetwork · Apr 29, 2024 · 43a0e72 · 43a0e72
2 parents 42a16a7 + e27dcfc
commit 43a0e72
Show file tree

Hide file tree

Showing 14 changed files with 471 additions and 391 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -8183,6 +8183,7 @@ Application uplink message.
 | `last_a_f_cnt_down` | [`uint32`](#uint32) |  | The last AFCntDown of the current session. This field is only present if the skip_payload_crypto field of the EndDevice is true. Can be used with app_s_key to encrypt downlink payloads. |
 | `confirmed` | [`bool`](#bool) |  | Indicates whether the end device used confirmed data uplink. |
 | `consumed_airtime` | [`google.protobuf.Duration`](#google.protobuf.Duration) |  | Consumed airtime for the transmission of the uplink message. Calculated by Network Server using the raw payload size and the transmission settings. |
+| `packet_error_rate` | [`float`](#float) |  | Packet error rate of the recent uplinks in the current session. Calculated by the Network Server. The value is defined in the [0, 1] interval. |
 | `locations` | [`ApplicationUplink.LocationsEntry`](#ttn.lorawan.v3.ApplicationUplink.LocationsEntry) | repeated | End device location metadata, set by the Application Server while handling the message. |
 | `version_ids` | [`EndDeviceVersionIdentifiers`](#ttn.lorawan.v3.EndDeviceVersionIdentifiers) |  | End device version identifiers, set by the Application Server while handling the message. |
 | `network_ids` | [`NetworkIdentifiers`](#ttn.lorawan.v3.NetworkIdentifiers) |  | Network identifiers, set by the Network Server that handles the message. |

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -19396,6 +19396,11 @@
           "type": "string",
           "description": "Consumed airtime for the transmission of the uplink message. Calculated by Network Server using the raw payload size and the transmission settings."
         },
+        "packet_error_rate": {
+          "type": "number",
+          "format": "float",
+          "description": "Packet error rate of the recent uplinks in the current session.\nCalculated by the Network Server. The value is defined in the [0, 1] interval."
+        },
         "locations": {
           "type": "object",
           "additionalProperties": {

diff --git a/api/ttn/lorawan/v3/messages.proto b/api/ttn/lorawan/v3/messages.proto
@@ -246,6 +246,10 @@ message ApplicationUplink {
   // Consumed airtime for the transmission of the uplink message. Calculated by Network Server using the raw payload size and the transmission settings.
   google.protobuf.Duration consumed_airtime = 13;
 
+  // Packet error rate of the recent uplinks in the current session.
+  // Calculated by the Network Server. The value is defined in the [0, 1] interval.
+  float packet_error_rate = 19;
+
   // End device location metadata, set by the Application Server while handling the message.
   map<string, Location> locations = 14;
 
@@ -255,7 +259,7 @@ message ApplicationUplink {
   // Network identifiers, set by the Network Server that handles the message.
   NetworkIdentifiers network_ids = 16;
 
-  // next: 19
+  // next: 20
 }
 
 message ApplicationUplinkNormalized {

diff --git a/pkg/networkserver/grpc_gsns.go b/pkg/networkserver/grpc_gsns.go
@@ -1150,6 +1150,7 @@ func (ns *NetworkServer) handleDataUplink(ctx context.Context, up *ttnpb.UplinkM
 					Settings:        up.Settings,
 					ReceivedAt:      up.ReceivedAt,
 					ConsumedAirtime: up.ConsumedAirtime,
+					PacketErrorRate: mac.LossRate(stored.MacState, matched.phy),
 					NetworkIds:      ns.networkIdentifiers(ctx),
 				},
 			},

diff --git a/pkg/networkserver/mac/adr.go b/pkg/networkserver/mac/adr.go
@@ -712,3 +712,8 @@ func AdaptDataRate(ctx context.Context, dev *ttnpb.EndDevice, phy *band.Band, de
 	}
 	return adaptDataRate(ctx, dev, phy, defaults)
 }
+
+// LossRate calculates the loss rate of the recent uplinks in the provided MAC state.
+func LossRate(macState *ttnpb.MACState, phy *band.Band) float32 {
+	return adrLossRate(adrUplinks(macState, phy)...)
+}
diff --git a/pkg/ttnpb/applicationserver.pb.paths.fm.go b/pkg/ttnpb/applicationserver.pb.paths.fm.go
diff --git a/pkg/ttnpb/messages.pb.go b/pkg/ttnpb/messages.pb.go
diff --git a/pkg/ttnpb/messages.pb.paths.fm.go b/pkg/ttnpb/messages.pb.paths.fm.go
diff --git a/pkg/ttnpb/messages.pb.setters.fm.go b/pkg/ttnpb/messages.pb.setters.fm.go
diff --git a/pkg/ttnpb/messages.pb.validate.go b/pkg/ttnpb/messages.pb.validate.go
diff --git a/pkg/ttnpb/messages_flags.pb.go b/pkg/ttnpb/messages_flags.pb.go
diff --git a/pkg/ttnpb/messages_json.pb.go b/pkg/ttnpb/messages_json.pb.go
diff --git a/sdk/js/generated/api-definition.json b/sdk/js/generated/api-definition.json
@@ -887,6 +887,7 @@
         "up.uplink_message.network_ids.tenant_id",
         "up.uplink_message.normalized_payload",
         "up.uplink_message.normalized_payload_warnings",
+        "up.uplink_message.packet_error_rate",
         "up.uplink_message.received_at",
         "up.uplink_message.rx_metadata",
         "up.uplink_message.session_key_id",

diff --git a/sdk/js/generated/api.json b/sdk/js/generated/api.json
@@ -36939,6 +36939,18 @@
               "oneofdecl": "",
               "defaultValue": ""
             },
+            {
+              "name": "packet_error_rate",
+              "description": "Packet error rate of the recent uplinks in the current session.\nCalculated by the Network Server. The value is defined in the [0, 1] interval.",
+              "label": "",
+              "type": "float",
+              "longType": "float",
+              "fullType": "float",
+              "ismap": false,
+              "isoneof": false,
+              "oneofdecl": "",
+              "defaultValue": ""
+            },
             {
               "name": "locations",
               "description": "End device location metadata, set by the Application Server while handling the message.",