Introduce Network::shortNetworkName

DavidSchinazi · Dec 11, 2023 · d2e689f · d2e689f
1 parent 33ebb71
commit d2e689f
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 9 deletions.
diff --git a/src/jazzlights/core2.cpp b/src/jazzlights/core2.cpp
@@ -627,15 +627,11 @@ std::string bleStatus(Milliseconds currentTime) {
 }
 
 std::string otherStatus(Player& player, Milliseconds currentTime) {
-  char otherStatusStr[100] = "Leading";
-  if (player.followedNextHopNetwork() == ArduinoEspWiFiNetwork::get()) {
-    snprintf(otherStatusStr, sizeof(otherStatusStr) - 1, "Following Wi-Fi nh=%u", player.currentNumHops());
-  }
-#if ESP32_BLE
-  else if (player.followedNextHopNetwork() == Esp32BleNetwork::get()) {
-    snprintf(otherStatusStr, sizeof(otherStatusStr) - 1, "Following BLE nh=%u", player.currentNumHops());
-  }
-#endif  // ESP32_BLE
+  const Network* followedNextHopNetwork = player.followedNextHopNetwork();
+  if (followedNextHopNetwork == nullptr) { return std::string("Leading"); }
+  char otherStatusStr[100] = {};
+  snprintf(otherStatusStr, sizeof(otherStatusStr) - 1, "Following %s nh=%u", followedNextHopNetwork->shortNetworkName(),
+           player.currentNumHops());
   return std::string(otherStatusStr);
 }
 

diff --git a/src/jazzlights/network.h b/src/jazzlights/network.h
@@ -124,6 +124,9 @@ class Network {
   // A static name for this network class suitable for logging.
   virtual const char* networkName() const = 0;
 
+  // A static name for this network class suitable for displaying when screen size is limited.
+  virtual const char* shortNetworkName() const = 0;
+
   // Whether we should advertise patterns on this network if that's where we received them.
   virtual bool shouldEcho() const = 0;
 

diff --git a/src/jazzlights/networks/arduino_esp_wifi.h b/src/jazzlights/networks/arduino_esp_wifi.h
@@ -30,6 +30,7 @@ class ArduinoEspWiFiNetwork : public UdpNetwork {
   void send(void* buf, size_t bufsize) override;
   NetworkDeviceId getLocalDeviceId() override { return localDeviceId_; }
   const char* networkName() const override { return "ArduinoEspWiFiNetwork"; }
+  const char* shortNetworkName() const override { return "WiFi"; }
   std::string getStatusStr(Milliseconds currentTime) const override;
 
   struct Credentials {

diff --git a/src/jazzlights/networks/arduino_ethernet.h b/src/jazzlights/networks/arduino_ethernet.h
@@ -31,6 +31,7 @@ class ArduinoEthernetNetwork : public UdpNetwork {
   void send(void* buf, size_t bufsize) override;
   NetworkDeviceId getLocalDeviceId() override { return localDeviceId_; }
   const char* networkName() const override { return "ArduinoEthernet"; }
+  const char* shortNetworkName() const override { return "Eth"; }
   std::string getStatusStr(Milliseconds currentTime) const override;
 
  private:

diff --git a/src/jazzlights/networks/esp32_ble.h b/src/jazzlights/networks/esp32_ble.h
@@ -37,6 +37,7 @@ class Esp32BleNetwork : public Network {
   // Get this device's BLE MAC address.
   NetworkDeviceId getLocalDeviceId() override { return localDeviceId_; }
   const char* networkName() const override { return "ESP32BLE"; }
+  const char* shortNetworkName() const override { return "BLE"; }
   bool shouldEcho() const override { return true; }
   Milliseconds getLastReceiveTime() const override { return lastReceiveTime_; }
   std::string getStatusStr(Milliseconds currentTime) const override;

diff --git a/src/jazzlights/networks/esp32_wifi.h b/src/jazzlights/networks/esp32_wifi.h
@@ -31,6 +31,7 @@ class Esp32WiFiNetwork : public Network {
   NetworkStatus update(NetworkStatus status, Milliseconds currentTime) override;
   NetworkDeviceId getLocalDeviceId() override { return localDeviceId_; }
   const char* networkName() const override { return "Esp32WiFi"; }
+  const char* shortNetworkName() const override { return "WiFi"; }
   std::string getStatusStr(Milliseconds currentTime) const override;
   void setMessageToSend(const NetworkMessage& messageToSend, Milliseconds currentTime) override;
   void disableSending(Milliseconds currentTime) override;

diff --git a/src/jazzlights/networks/unix_udp.h b/src/jazzlights/networks/unix_udp.h
@@ -22,6 +22,7 @@ class UnixUdpNetwork : public UdpNetwork {
   int recv(void* buf, size_t bufsize, std::string* details) override;
   void send(void* buf, size_t bufsize) override;
   const char* networkName() const override { return "UnixUDP"; }
+  const char* shortNetworkName() const override { return "Unix"; }
   std::string getStatusStr(Milliseconds /*currentTime*/) const override { return "UnixUDP"; }
 
  private: