Partially overhaul logging & make base containers

Author: addshore

examples/containers/base-debug.toit

@@ -0,0 +1,11 @@
+import lightbug.devices as devices
+import lightbug.messages as messages
+import lightbug.modules.comms.message-handler show MessageHandler
+import lightbug.modules.strobe.strobe show Strobe
+import lightbug.protocol as protocol
+import log
+
+main:
+  device := (devices.RtkHandheld2 --open=false --logger=((log.default.with-name "lb").with-level log.DEBUG-LEVEL) ).comms
+  while true:
+    sleep --ms=10000

examples/containers/base.toit

@@ -0,0 +1,11 @@
+import lightbug.devices as devices
+import lightbug.messages as messages
+import lightbug.modules.comms.message-handler show MessageHandler
+import lightbug.modules.strobe.strobe show Strobe
+import lightbug.protocol as protocol
+import log
+
+main:
+  device := (devices.RtkHandheld2 --open=false).comms
+  while true:
+    sleep --ms=10000

src/devices/base.toit

@@ -49,10 +49,10 @@ interface HasInOut:
   out -> io.Writer
 
 /*
-A base class for Lightbug devices
+A base class for Lightbug I2C devices
 Containing the common I2C implementation
 */
-abstract class LightbugDevice implements Device:
+abstract class LightbugI2CDevice implements Device:
   static I2C-SDA := 6
   static I2C-SCL := 7
 
@@ -73,16 +73,17 @@ abstract class LightbugDevice implements Device:
   constructor name/string i2c-sda/int=I2C-SDA i2c-scl/int=I2C-SCL --i2c-frequency/int=100_000
       --strobe/Strobe=NoStrobe
       --open/bool=true
-      --logger/log.Logger=(log.default.with-name "lb-device"):
+      // Default to a logger named "lb" with ERROR level
+      --logger/log.Logger=((log.default.with-name "lb").with-level log.ERROR-LEVEL):
     // TODO if more than one device is instantiated, things will likely break due to gpio / i2c conflicts, so WARN / throw in this case
     name_ = name
     strobe_ = strobe
     logger_ = logger
     open_ = open
     i2c-bus = LBI2CBus --sda=i2c-sda --scl=i2c-scl --frequency=i2c-frequency
     i2c-device_ = LBI2CDevice i2c-bus
-    i2c-reader_ = Reader i2c-device_ --logger=logger_
-    i2c-writer_ = Writer i2c-device_ --logger=logger_
+    i2c-reader_ = Reader i2c-device_ --logger=(logger_.with-name "i2c.read")
+    i2c-writer_ = Writer i2c-device_ --logger=(logger_.with-name "i2c.write")
 
   name -> string:
     return name_
@@ -93,6 +94,7 @@ abstract class LightbugDevice implements Device:
       comms_ = Comms 
           --device=this
           --open=open_
+          --logger=(logger_.with-name "comms")
       // Auto-register BLE handler for all devices with BLE support
       auto-register-ble-handler_
       // Auto-register WiFi handler for all devices with WiFi support
@@ -104,11 +106,11 @@ abstract class LightbugDevice implements Device:
     return buttons_
   ble -> BLE:
     if not ble_:
-      ble_ = BLE
+      ble_ = BLE --logger=(logger_.with-name "ble")
     return ble_
   wifi -> WiFi:
     if not wifi_:
-      wifi_ = WiFi
+      wifi_ = WiFi --logger=(logger_.with-name "wifi")
     return wifi_
   messages-supported -> List:
     return []
@@ -148,15 +150,15 @@ abstract class LightbugDevice implements Device:
    */
   auto-register-ble-handler_:
     e := catch:
-      ble-handler := BLEHandler this comms_
+      ble-handler := BLEHandler this comms_ --logger=(logger_.with-name "h.ble")
       comms_.register-handler ble-handler
       logger_.debug "Auto-registered BLE message handler"
     if e:
       logger_.warn "Failed to register BLE handler: $e"
 
   auto-register-wifi-handler_:
     e := catch:
-      wifi-handler := WiFiHandler this comms_
+      wifi-handler := WiFiHandler this comms_ --logger=(logger_.with-name "h.wifi")
       comms_.register-handler wifi-handler
       logger_.debug "Auto-registered WiFi message handler"
     if e:

src/devices/devices.toit

@@ -1,4 +1,4 @@
-import .base show Device LightbugDevice
+import .base show Device LightbugI2CDevice
 import .fake show Fake
 import .rh2 show RtkHandheld2 RtkHandheld2Rev2
 import .zcard show ZCard

src/devices/fake.toit

@@ -1,5 +1,6 @@
 import i2c
 import io
+import log
 import .base
 import .i2c
 import ..modules.strobe
@@ -35,11 +36,11 @@ class Fake implements Device:
     return buttons_
   ble -> BLE:
     if not ble_:
-      ble_ = BLE
+      ble_ = BLE --logger=(log.default.with-name "lb.ble")
     return ble_
   wifi -> WiFi:
     if not wifi_:
-      wifi_ = WiFi
+      wifi_ = WiFi --logger=(log.default.with-name "lb.wifi")
     return wifi_
   messages-supported -> List:
     return []

src/devices/rh2.toit

@@ -1,5 +1,6 @@
 import i2c
 import io
+import log
 import .base
 import .i2c
 import ..modules.strobe
@@ -10,27 +11,27 @@ RtkHandheld2-MESSAGES := [
 
 // The latest revision of the RtkHandheld2 device
 class RtkHandheld2 extends RtkHandheld2Rev5:
-  constructor --open/bool=true:
-    super --open=open
+  constructor --open/bool=true --logger/log.Logger=((log.default.with-name "lb").with-level log.ERROR-LEVEL):
+    super --open=open --logger=logger
 
 // The RtkHandheld2 device, currently at revision 5
-class RtkHandheld2Rev5 extends LightbugDevice:
-  constructor --open/bool=true:
-    super "RtkHandheld2" --strobe=StandardStrobe --i2c-frequency=100_000 --open=open
+class RtkHandheld2Rev5 extends LightbugI2CDevice:
+  constructor --open/bool=true --logger/log.Logger=((log.default.with-name "lb").with-level log.ERROR-LEVEL):
+    super "RtkHandheld2" --strobe=StandardStrobe --i2c-frequency=100_000 --open=open --logger=logger
   messages-supported -> List:
     return RtkHandheld2-MESSAGES
 
 // Rev 3 and 4 of the RtkHandheld2 device (slower I2C speed)
 // Introduced Feb 2025
-class RtkHandheld2Rev3 extends LightbugDevice:
+class RtkHandheld2Rev3 extends LightbugI2CDevice:
   constructor --open/bool=true:
     super "RtkHandheld2" --strobe=StandardStrobe --open=open
   messages-supported -> List:
     return RtkHandheld2-MESSAGES
 
 // Rev 2 of the RtkHandheld2 device, with different I2C pins
 // Retired Feb 2025
-class RtkHandheld2Rev2 extends LightbugDevice:
+class RtkHandheld2Rev2 extends LightbugI2CDevice:
   static I2C-SDA := 0
   static I2C-SCL := 1
   constructor --open/bool=true:

src/devices/uart.toit

@@ -1,6 +1,7 @@
 import uart
 import gpio
 import io
+import log
 import .base
 import ..modules.strobe
 import ..modules.comms
@@ -49,11 +50,11 @@ class GenericUart implements Device:
     return buttons_
   ble -> BLE:
     if not ble_:
-      ble_ = BLE
+      ble_ = BLE --logger=(log.default.with-name "lb.ble")
     return ble_
   wifi -> WiFi:
     if not wifi_:
-      wifi_ = WiFi
+      wifi_ = WiFi --logger=(log.default.with-name "lb.wifi")
     return wifi_
   messages-supported -> List:
     return []

src/devices/zcard.toit

@@ -37,7 +37,7 @@ class ZCard extends ZCardRev2:
 
 // The second of the ZCard devices
 // Introduced Mid 2025
-class ZCardRev2 extends LightbugDevice:
+class ZCardRev2 extends LightbugI2CDevice:
   constructor --open/bool=true:
     super "ZCard" --strobe=(StandardStrobe --initial-value=1) --open=open
   messages-supported -> List:
@@ -52,7 +52,7 @@ class ZCardRev2 extends LightbugDevice:
 
 // The first ZCard devices
 // Introduced Feb 2025
-class ZCardRev1 extends LightbugDevice:
+class ZCardRev1 extends LightbugI2CDevice:
   constructor --open/bool=true:
     super "ZCard" --strobe=(StandardStrobe --initial-value=1) --open=open
   messages-supported -> List:

src/modules/ble/ble.toit

@@ -13,8 +13,8 @@ class BLE:
   logger_/log.Logger
   adapter_/ble.Adapter
 
-  constructor --logger/log.Logger?=null:
-    logger_ = logger ? log.default.with-name "lb-ble" : log.default.with-name "lb-ble"
+  constructor --logger/log.Logger:
+    logger_ = logger
     adapter_ = ble.Adapter
 
   /**

src/modules/ble/handler.toit

@@ -18,7 +18,7 @@ class BLEHandler implements MessageHandler:
   device_/devices.Device
   comms_/any  // Reference to the comms instance for sending responses
   
-  constructor device/devices.Device comms/any --logger/log.Logger=(log.default.with-name "lb-ble-handler"):
+  constructor device/devices.Device comms/any --logger/log.Logger:
     logger_ = logger
     device_ = device
     comms_ = comms