Support wifi heartbeats originating from indoor wifi hotspots

file_store/src/cli/bucket.rs

@@ -1,5 +1,5 @@
 use crate::{
-    heartbeat::CellHeartbeat, iot_beacon_report::IotBeaconIngestReport, iot_valid_poc::IotPoc,
+    heartbeat::CbrsHeartbeat, iot_beacon_report::IotBeaconIngestReport, iot_valid_poc::IotPoc,
     iot_witness_report::IotWitnessIngestReport, speedtest::CellSpeedtest, traits::MsgDecode, Error,
     FileInfoStream, FileStore, FileType, Result, Settings,
 };
@@ -204,8 +204,8 @@ impl Locate {
 fn locate(prefix: &str, gateway: &PublicKey, buf: &[u8]) -> Result<Option<serde_json::Value>> {
     let pub_key = gateway.to_vec();
     match FileType::from_str(prefix)? {
-        FileType::CellHeartbeat => {
-            CellHeartbeat::decode(buf).and_then(|event| event.to_value_if(pub_key))
+        FileType::CbrsHeartbeat => {
+            CbrsHeartbeat::decode(buf).and_then(|event| event.to_value_if(pub_key))
         }
         FileType::CellSpeedtest => {
             CellSpeedtest::decode(buf).and_then(|event| event.to_value_if(pub_key))
@@ -254,7 +254,7 @@ where
     }
 }
 
-impl Gateway for CellHeartbeat {
+impl Gateway for CbrsHeartbeat {
     fn has_pubkey(&self, pub_key: &[u8]) -> bool {
         self.pubkey.as_ref() == pub_key
     }

file_store/src/cli/dump.rs

@@ -1,12 +1,13 @@
 use crate::{
     cli::print_json,
     file_source,
-    heartbeat::{CellHeartbeat, CellHeartbeatIngestReport},
+    heartbeat::{CbrsHeartbeat, CbrsHeartbeatIngestReport},
     iot_packet::IotValidPacket,
     mobile_session::{DataTransferSessionIngestReport, InvalidDataTransferIngestReport},
     mobile_subscriber::{SubscriberLocationIngestReport, VerifiedSubscriberLocationIngestReport},
     speedtest::{CellSpeedtest, CellSpeedtestIngestReport},
     traits::MsgDecode,
+    wifi_heartbeat::WifiHeartbeatIngestReport,
     FileType, Result, Settings,
 };
 use base64::Engine;
@@ -50,17 +51,27 @@ impl Cmd {
         while let Some(result) = file_stream.next().await {
             let msg = result?;
             match self.file_type {
-                FileType::CellHeartbeat => {
+                FileType::CbrsHeartbeat => {
                     let dec_msg = CellHeartbeatReqV1::decode(msg)?;
-                    wtr.serialize(CellHeartbeat::try_from(dec_msg)?)?;
+                    wtr.serialize(CbrsHeartbeat::try_from(dec_msg)?)?;
+                }
+                FileType::WifiHeartbeatIngestReport => {
+                    let msg = WifiHeartbeatIngestReport::decode(msg)?;
+                    let json = json!({
+                        "received_timestamp": msg.received_timestamp,
+                        "pubkey": msg.report.pubkey,
+                        "operation_mode": msg.report.operation_mode,
+                        "location_validation_timestamp": msg.report.location_validation_timestamp,
+                    });
+                    print_json(&json)?;
                 }
                 FileType::CellSpeedtest => {
                     let dec_msg = SpeedtestReqV1::decode(msg)?;
                     wtr.serialize(CellSpeedtest::try_from(dec_msg)?)?;
                 }
-                FileType::CellHeartbeatIngestReport => {
+                FileType::CbrsHeartbeatIngestReport => {
                     let dec_msg = CellHeartbeatIngestReportV1::decode(msg)?;
-                    let ingest_report = CellHeartbeatIngestReport::try_from(dec_msg)?;
+                    let ingest_report = CbrsHeartbeatIngestReport::try_from(dec_msg)?;
                     print_json(&ingest_report)?;
                 }
                 FileType::CellSpeedtestIngestReport => {
@@ -207,6 +218,7 @@ impl Cmd {
                             "dc_transfer_reward": reward.dc_transfer_reward,
                         }))?,
                         Some(Reward::RadioReward(reward)) => print_json(&json!({
+                            "hotspot_key":  PublicKey::try_from(reward.hotspot_key)?,
                             "cbsd_id": reward.cbsd_id,
                             "poc_reward": reward.poc_reward,
                         }))?,

file_store/src/cli/info.rs

@@ -74,13 +74,13 @@ impl MsgTimestamp<Result<DateTime<Utc>>> for PriceReportV1 {
 
 fn get_timestamp(file_type: &str, buf: &[u8]) -> Result<DateTime<Utc>> {
     let result = match FileType::from_str(file_type)? {
-        FileType::CellHeartbeat => CellHeartbeatReqV1::decode(buf)
+        FileType::CbrsHeartbeat => CellHeartbeatReqV1::decode(buf)
             .map_err(Error::from)
             .and_then(|entry| entry.timestamp())?,
         FileType::CellSpeedtest => SpeedtestReqV1::decode(buf)
             .map_err(Error::from)
             .and_then(|entry| entry.timestamp())?,
-        FileType::CellHeartbeatIngestReport => CellHeartbeatIngestReportV1::decode(buf)
+        FileType::CbrsHeartbeatIngestReport => CellHeartbeatIngestReportV1::decode(buf)
             .map_err(Error::from)
             .and_then(|ingest_report| {
                 ingest_report.report.ok_or_else(|| {

file_store/src/file_info.rs

@@ -109,10 +109,12 @@ impl FileInfo {
 pub const SUBSCRIBER_LOCATION_REQ: &str = "subscriber_location_req";
 pub const SUBSCRIBER_LOCATION_INGEST_REPORT: &str = "subscriber_location_report";
 pub const VERIFIED_SUBSCRIBER_LOCATION_INGEST_REPORT: &str = "verified_subscriber_location_report";
-pub const CELL_HEARTBEAT: &str = "cell_heartbeat";
+pub const CBRS_HEARTBEAT: &str = "cbrs_heartbeat";
+pub const WIFI_HEARTBEAT: &str = "wifi_heartbeat";
 pub const CELL_SPEEDTEST: &str = "cell_speedtest";
 pub const VERIFIED_SPEEDTEST: &str = "verified_speedtest";
 pub const CELL_HEARTBEAT_INGEST_REPORT: &str = "heartbeat_report";
+pub const WIFI_HEARTBEAT_INGEST_REPORT: &str = "wifi_heartbeat_report";
 pub const CELL_SPEEDTEST_INGEST_REPORT: &str = "speedtest_report";
 pub const ENTROPY: &str = "entropy";
 pub const SUBNETWORK_REWARDS: &str = "subnetwork_rewards";
@@ -144,11 +146,11 @@ pub const COVERAGE_OBJECT_INGEST_REPORT: &str = "coverage_object_ingest_report";
 #[derive(Debug, PartialEq, Eq, Clone, Serialize, Copy, strum::EnumCount)]
 #[serde(rename_all = "snake_case")]
 pub enum FileType {
-    CellHeartbeat = 0,
+    CbrsHeartbeat = 0,
     CellSpeedtest = 1,
     Entropy = 2,
     SubnetworkRewards = 3,
-    CellHeartbeatIngestReport,
+    CbrsHeartbeatIngestReport,
     CellSpeedtestIngestReport,
     EntropyReport,
     IotBeaconIngestReport,
@@ -177,6 +179,8 @@ pub enum FileType {
     MapperMsg,
     CoverageObjectIngestReport,
     VerifiedSpeedtest,
+    WifiHeartbeat,
+    WifiHeartbeatIngestReport,
 }
 
 impl fmt::Display for FileType {
@@ -187,10 +191,12 @@ impl fmt::Display for FileType {
             Self::VerifiedSubscriberLocationIngestReport => {
                 VERIFIED_SUBSCRIBER_LOCATION_INGEST_REPORT
             }
-            Self::CellHeartbeat => CELL_HEARTBEAT,
+            Self::CbrsHeartbeat => CBRS_HEARTBEAT,
+            Self::WifiHeartbeat => WIFI_HEARTBEAT,
             Self::CellSpeedtest => CELL_SPEEDTEST,
             Self::VerifiedSpeedtest => VERIFIED_SPEEDTEST,
-            Self::CellHeartbeatIngestReport => CELL_HEARTBEAT_INGEST_REPORT,
+            Self::CbrsHeartbeatIngestReport => CELL_HEARTBEAT_INGEST_REPORT,
+            Self::WifiHeartbeatIngestReport => WIFI_HEARTBEAT_INGEST_REPORT,
             Self::CellSpeedtestIngestReport => CELL_SPEEDTEST_INGEST_REPORT,
             Self::Entropy => ENTROPY,
             Self::SubnetworkRewards => SUBNETWORK_REWARDS,
@@ -232,10 +238,12 @@ impl FileType {
             Self::VerifiedSubscriberLocationIngestReport => {
                 VERIFIED_SUBSCRIBER_LOCATION_INGEST_REPORT
             }
-            Self::CellHeartbeat => CELL_HEARTBEAT,
+            Self::CbrsHeartbeat => CBRS_HEARTBEAT,
+            Self::WifiHeartbeat => WIFI_HEARTBEAT,
             Self::CellSpeedtest => CELL_SPEEDTEST,
             Self::VerifiedSpeedtest => VERIFIED_SPEEDTEST,
-            Self::CellHeartbeatIngestReport => CELL_HEARTBEAT_INGEST_REPORT,
+            Self::CbrsHeartbeatIngestReport => CELL_HEARTBEAT_INGEST_REPORT,
+            Self::WifiHeartbeatIngestReport => WIFI_HEARTBEAT_INGEST_REPORT,
             Self::CellSpeedtestIngestReport => CELL_SPEEDTEST_INGEST_REPORT,
             Self::Entropy => ENTROPY,
             Self::SubnetworkRewards => SUBNETWORK_REWARDS,
@@ -277,10 +285,12 @@ impl FromStr for FileType {
             VERIFIED_SUBSCRIBER_LOCATION_INGEST_REPORT => {
                 Self::VerifiedSubscriberLocationIngestReport
             }
-            CELL_HEARTBEAT => Self::CellHeartbeat,
+            CBRS_HEARTBEAT => Self::CbrsHeartbeat,
+            WIFI_HEARTBEAT => Self::WifiHeartbeat,
             CELL_SPEEDTEST => Self::CellSpeedtest,
             VERIFIED_SPEEDTEST => Self::VerifiedSpeedtest,
-            CELL_HEARTBEAT_INGEST_REPORT => Self::CellHeartbeatIngestReport,
+            CELL_HEARTBEAT_INGEST_REPORT => Self::CbrsHeartbeatIngestReport,
+            WIFI_HEARTBEAT_INGEST_REPORT => Self::WifiHeartbeatIngestReport,
             CELL_SPEEDTEST_INGEST_REPORT => Self::CellSpeedtestIngestReport,
             ENTROPY => Self::Entropy,
             SUBNETWORK_REWARDS => Self::SubnetworkRewards,

file_store/src/heartbeat.rs

@@ -8,7 +8,7 @@ use helium_proto::services::poc_mobile::{CellHeartbeatIngestReportV1, CellHeartb
 use serde::{Deserialize, Serialize};
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
-pub struct CellHeartbeat {
+pub struct CbrsHeartbeat {
     pub pubkey: PublicKeyBinary,
     pub hotspot_type: String,
     pub cell_id: u32,
@@ -21,20 +21,20 @@ pub struct CellHeartbeat {
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
-pub struct CellHeartbeatIngestReport {
+pub struct CbrsHeartbeatIngestReport {
     pub received_timestamp: DateTime<Utc>,
-    pub report: CellHeartbeat,
+    pub report: CbrsHeartbeat,
 }
 
-impl MsgDecode for CellHeartbeat {
+impl MsgDecode for CbrsHeartbeat {
     type Msg = CellHeartbeatReqV1;
 }
 
-impl MsgDecode for CellHeartbeatIngestReport {
+impl MsgDecode for CbrsHeartbeatIngestReport {
     type Msg = CellHeartbeatIngestReportV1;
 }
 
-impl TryFrom<CellHeartbeatReqV1> for CellHeartbeat {
+impl TryFrom<CellHeartbeatReqV1> for CbrsHeartbeat {
     type Error = Error;
     fn try_from(v: CellHeartbeatReqV1) -> Result<Self> {
         Ok(Self {
@@ -57,7 +57,7 @@ impl MsgTimestamp<Result<DateTime<Utc>>> for CellHeartbeatReqV1 {
     }
 }
 
-impl TryFrom<CellHeartbeatIngestReportV1> for CellHeartbeatIngestReport {
+impl TryFrom<CellHeartbeatIngestReportV1> for CbrsHeartbeatIngestReport {
     type Error = Error;
     fn try_from(v: CellHeartbeatIngestReportV1) -> Result<Self> {
         Ok(Self {
@@ -108,17 +108,17 @@ mod tests {
 
         let buffer = report.encode_to_vec();
 
-        let cellheartbeatreport = CellHeartbeatIngestReport::decode(buffer.as_slice())
-            .expect("unable to decode into CellHeartbeat");
+        let heartbeatreport = CbrsHeartbeatIngestReport::decode(buffer.as_slice())
+            .expect("unable to decode into CbrsHeartbeat");
 
         assert_eq!(
-            cellheartbeatreport.received_timestamp,
+            heartbeatreport.received_timestamp,
             Utc.timestamp_millis_opt(now).unwrap()
         );
         assert_eq!(
             report.timestamp().expect("timestamp"),
-            cellheartbeatreport.received_timestamp
+            heartbeatreport.received_timestamp
         );
-        assert_eq!(cellheartbeatreport.report.cell_id, 123);
+        assert_eq!(heartbeatreport.report.cell_id, 123);
     }
 }

file_store/src/lib.rs

@@ -20,6 +20,7 @@ pub mod reward_manifest;
 mod settings;
 pub mod speedtest;
 pub mod traits;
+pub mod wifi_heartbeat;
 
 pub use crate::file_store::FileStore;
 pub use cli::bucket::FileFilter;

file_store/src/traits/msg_verify.rs

@@ -7,7 +7,7 @@ use helium_proto::services::{
 use helium_proto::{
     services::poc_mobile::{
         CellHeartbeatReqV1, CoverageObjectReqV1, DataTransferSessionReqV1, SpeedtestReqV1,
-        SubscriberLocationReqV1,
+        SubscriberLocationReqV1, WifiHeartbeatReqV1,
     },
     Message,
 };
@@ -31,6 +31,7 @@ macro_rules! impl_msg_verify {
 }
 impl_msg_verify!(SubscriberLocationReqV1, signature);
 impl_msg_verify!(CellHeartbeatReqV1, signature);
+impl_msg_verify!(WifiHeartbeatReqV1, signature);
 impl_msg_verify!(SpeedtestReqV1, signature);
 impl_msg_verify!(LoraBeaconReportReqV1, signature);
 impl_msg_verify!(LoraWitnessReportReqV1, signature);