boneIO 1.6.0.dev34__py3-none-any.whl → 1.6.0.dev35__py3-none-any.whl

boneio/core/cloud/registration.py

@@ -119,7 +119,13 @@ class CloudRegistration:
 
     @property
     def is_compose_writable(self) -> bool:
-        """Check if docker-compose.yaml is writable without side effects."""
+        """Check if docker-compose.yaml is writable without side effects.
+
+        True for the packaged Caddy: there is no compose file to be writable,
+        and the panel warns when this is False.
+        """
+        if containers.proxy_mode() == "native":
+            return True
         compose_file = _DOCKER_DIR / "docker-compose.yaml"
         if not compose_file.exists():
             return False
@@ -521,6 +527,9 @@ class CloudRegistration:
         This ensures the script is always up-to-date after a pip upgrade,
         even if the user never re-clones the full repo.
         """
+        if containers.proxy_mode() == "native":
+            # The generator writes the cloud block itself; no script is mounted.
+            return
         dest = CADDY_CONFIG_DIR / "init-certs-cloud.sh"
         try:
             src = files("boneio.core.cloud.data").joinpath("init-certs-cloud.sh")
@@ -661,19 +670,15 @@ class CloudRegistration:
 
     def is_cloud_config_active(self) -> bool:
         """
-        Check if cloud init-certs script is active in docker-compose.
+        Check if the cloud template is the one in use.
+
+        Asked of the compose file in container mode and of the helper's marker
+        for the packaged Caddy, which has no compose file.
 
         Returns:
             True if cloud config is active
         """
-        try:
-            compose_file = _DOCKER_DIR / "docker-compose.yaml"
-            if not compose_file.exists():
-                return False
-            content = compose_file.read_text()
-            return "init-certs-cloud.sh" in content
-        except Exception:
-            return False
+        return containers.cloud_template_is_live()
 
 
 async def set_enabled(config_helper, enabled: bool, local_ip: str | None = None) -> str:

boneio/core/containers.py

@@ -90,6 +90,13 @@ _HELPER_ONLY = {
     # Read the root-owned template and rewrite the compose file's Caddy line.
     "caddy-image-state",
     "caddy-image-apply",
+    # Root reads Caddy's own copy; without the helper the panel reads it itself.
+    "caddy-root-ca",
+    # Installs a package and starts it as root, in a unit of its own.
+    "proxy-switch-start",
+    "proxy-switch-run",
+    "proxy-switch-state",
+    "proxy-switch-recover",
 }
 
 
@@ -453,6 +460,60 @@ def caddy_image_apply(timeout: int = 1300) -> Result:
     return run("caddy-image-apply", timeout=timeout)
 
 
+#: Present once Caddy is the apt package under systemd. Created only by the
+#: root helper's switch, and world-readable, so the application can look.
+NATIVE_MARKER = Path("/etc/boneio/proxy-native")
+
+
+#: Present while the cloud wildcard block is wanted by the packaged Caddy.
+#: Created and removed by the root helper's cloud-template verbs, which is the
+#: whole of what "the cloud template" means once there is no compose file.
+CLOUD_MARKER = Path("/etc/boneio/proxy-cloud")
+
+
+def proxy_mode() -> str:
+    """``"native"`` once Caddy runs as the package, else ``"container"``."""
+    try:
+        return "native" if NATIVE_MARKER.exists() else "container"
+    except OSError:
+        return "container"
+
+
+def proxy_switch_start(timeout: int = 60) -> Result:
+    """Start the move from the Caddy container to the package, and return.
+
+    The helper runs it in a unit of its own, so it outlives a boneIO restart;
+    it refuses while one runs and once Caddy is already the package.
+    """
+    return run("proxy-switch-start", timeout=timeout)
+
+
+def proxy_switch_state(timeout: int = 30) -> Result:
+    """The last switch's record and log tail, as JSON on stdout. Read-only."""
+    return run("proxy-switch-state", timeout=timeout)
+
+
+def proxy_switch_recover(timeout: int = 300) -> Result:
+    """Undo a switch that was cut short; a no-op for anything else."""
+    return run("proxy-switch-recover", timeout=timeout)
+
+
+def root_ca(timeout: int = 30) -> bytes | None:
+    """The PEM of Caddy's local root certificate, read by the helper.
+
+    One path for both modes: the helper knows where each keeps it, and in the
+    packaged one the data directory is not readable by the application.
+
+    Returns:
+        The certificate, or None when the helper is missing or too old to know
+        the verb, or Caddy has not created one yet.
+    """
+    result = run("caddy-root-ca", timeout=timeout)
+    if not result.ok or not result.stdout.strip():
+        return None
+    return result.stdout.encode()
+
+
 def remove_cloud_template(timeout: int = 60) -> Result:
     """Restore the plain compose template."""
     return run("remove-cloud-template", timeout=timeout)
@@ -539,6 +600,9 @@ def cloud_template_is_live() -> bool:
         cannot be read — the local template is the safe assumption, being the
         one that needs nothing from outside the device.
     """
+    if proxy_mode() == "native":
+        # No compose file to ask: the helper's marker is the template.
+        return CLOUD_MARKER.exists()
     try:
         body = COMPOSE_FILE.read_text()
     except OSError as err:

boneio/core/proxy_switch.py

@@ -0,0 +1,149 @@
+"""Moves a controller from the Caddy container to the packaged Caddy by itself.
+
+The move is the root helper's (``proxy-switch-start``), run in a unit of its
+own; this only decides when to ask for it and watches it finish. It waits for
+the controller to have settled, needs the package repository to be reachable,
+and gives up after a few failed runs so a controller that cannot make the move
+does not retry for ever. Everything that touches the helper or the network runs
+off the event loop, and nothing here waits on or blocks the inputs.
+"""
+
+from __future__ import annotations
+
+import asyncio
+import logging
+import socket
+
+from boneio.core import containers
+
+_LOGGER = logging.getLogger(__name__)
+
+#: Let the controller finish starting (discovery, Modbus, the first sensor
+#: reads) before a package install competes with it for a single core.
+START_DELAY = 300
+#: Between looks when a condition was not met (offline, helper not updated).
+RECHECK = 1800
+POLL = 10
+#: A switch that runs longer than this (30 minutes of polls) is left to the
+#: next look rather than watched for ever.
+MAX_POLLS = 180
+MAX_ATTEMPTS = 3
+#: Where the package comes from; no point starting the move without it.
+REPO_HOST = "dl.cloudsmith.io"
+
+
+def has_default_route() -> bool:
+    """Whether the kernel has a default IPv4 route (destination and mask zero)."""
+    try:
+        with open("/proc/net/route", encoding="ascii") as handle:
+            rows = [line.split() for line in handle.read().splitlines()[1:]]
+    except OSError:
+        return False
+    return any(len(r) > 7 and r[1] == "00000000" and r[7] == "00000000" for r in rows)
+
+
+def repo_resolves() -> bool:
+    """Whether the package repository's name resolves. Blocks; call off the loop."""
+    try:
+        socket.getaddrinfo(REPO_HOST, 443)
+    except OSError:
+        return False
+    return True
+
+
+def read_state() -> dict | None:
+    """The helper's switch record, or None when it cannot be read."""
+    result = containers.proxy_switch_state()
+    state = result.json() if result.ok else None
+    return state if isinstance(state, dict) else None
+
+
+#: The ``at`` of the interrupted record already undone, so one record is not
+#: undone twice; a later interrupted run has a new ``at``.
+_recovered_at: object = object()
+
+
+def _recover_if_cut_short(state: dict) -> dict | None:
+    """Undo a run the helper reports as interrupted, and read the record again.
+
+    The helper shows a ``running`` record with no unit as ``failed`` with the
+    error ``interrupted``; the record itself still says ``running`` until the
+    undo has run, which is what puts a stopped unit's container back. Covers
+    ``systemctl stop`` of the unit while boneIO keeps running (a boot unit
+    covers a reboot). Once per interrupted record.
+    """
+    global _recovered_at
+    if state.get("running") or state.get("error") != "interrupted":
+        return state
+    if state.get("at") == _recovered_at:
+        return state
+    _LOGGER.warning("Proxy switch was interrupted; undoing it")
+    _recovered_at = state.get("at")
+    containers.proxy_switch_recover()
+    return read_state()
+
+
+def _finished(state: dict) -> bool:
+    """Whether no further automatic attempt is due."""
+    attempts = state.get("attempts")
+    return state.get("state") == "done" or (isinstance(attempts, int) and attempts >= MAX_ATTEMPTS)
+
+
+async def attempt_switch() -> bool:
+    """One look: start the switch if every condition holds, and wait for it.
+
+    Returns:
+        Whether the automatic task is finished: Caddy is the package, or the
+        attempts are used up. False when it should look again later.
+    """
+    if not await asyncio.to_thread(containers.helper_supports, "proxy-switch-start"):
+        return False
+    state = await asyncio.to_thread(read_state)
+    if state is None:
+        return False
+    state = await asyncio.to_thread(_recover_if_cut_short, state)
+    if state is None:
+        return False
+    if await asyncio.to_thread(containers.proxy_mode) == "native":
+        return True
+    if state.get("running"):
+        return False
+    if _finished(state):
+        return True
+    if not await asyncio.to_thread(has_default_route):
+        return False
+    if not await asyncio.to_thread(repo_resolves):
+        return False
+
+    started = await asyncio.to_thread(containers.proxy_switch_start)
+    if not started.ok:
+        _LOGGER.warning("Proxy switch did not start: %s", (started.stderr or started.stdout).strip())
+        return False
+    _LOGGER.info("Proxy switch started")
+    for _ in range(MAX_POLLS):
+        await asyncio.sleep(POLL)
+        state = await asyncio.to_thread(read_state)
+        if state is not None and not state.get("running"):
+            break
+    if state is None:
+        return False
+    _LOGGER.info("Proxy switch finished: %s", state.get("state"))
+    # A unit stopped by hand ends here as interrupted; undo it now rather than
+    # at the next look, which may never come if the panel is what it broke.
+    state = await asyncio.to_thread(_recover_if_cut_short, state) or state
+    return _finished(state)
+
+
+async def run() -> None:
+    """Background task: look 5 minutes after start, then every half hour.
+
+    Ends once Caddy is the package or the automatic attempts are used up.
+    """
+    await asyncio.sleep(START_DELAY)
+    while True:
+        try:
+            if await attempt_switch():
+                return
+        except Exception:  # noqa: BLE001 - a failed look must not end the task
+            _LOGGER.exception("Proxy switch check failed")
+        await asyncio.sleep(RECHECK)

boneio/core/security/certificate.py

@@ -22,6 +22,8 @@ from pathlib import Path
 from cryptography import x509
 from cryptography.hazmat.primitives import hashes, serialization
 
+from boneio.core import containers
+
 _LOGGER = logging.getLogger(__name__)
 
 #: Refuse anything larger. A certificate chain is a few kilobytes; a megabyte
@@ -231,6 +233,41 @@ ROOT_CA = (
     / "authorities" / "local" / "root.crt"
 )
 
+
+def root_ca() -> bytes | None:
+    """Caddy's root certificate in whichever mode runs it.
+
+    Asked of the root helper, the only reader of the packaged Caddy's data. An
+    old helper that lacks the verb leaves the container mode reading the file
+    itself, as it always did; the packaged mode reads the generator's public
+    export, since its data directory is not the application's to read.
+
+    Returns:
+        The PEM, or None when there is none yet.
+    """
+    pem = containers.root_ca()
+    if pem is not None:
+        return pem
+    try:
+        return (
+            ROOT_CA_EXPORT if containers.proxy_mode() == "native" else ROOT_CA
+        ).read_bytes()
+    except OSError:
+        return None
+
+
+#: The public copy of that certificate the packaged Caddy's generator writes
+#: on every start and reload, world-readable, so that asking whether one exists
+#: needs no sudo.
+ROOT_CA_EXPORT = Path("/var/lib/boneio/proxy/root.crt")
+
+
+def root_ca_exists() -> bool:
+    """Whether a root certificate is there to offer; a plain file check."""
+    path = ROOT_CA_EXPORT if containers.proxy_mode() == "native" else ROOT_CA
+    return path.exists()
+
+
 #: The key is a secret, and it is written by the account the panel runs as.
 KEY_MODE = 0o600
 CERT_MODE = 0o644

boneio/{example_config → factory_config/0.8}/24x16/config.yaml

@@ -25,11 +25,11 @@ binary_sensor: !include binary_sensor.yaml
 output: !include output24x16A.yaml
 
 boneio:
-  config_version: 4
+  config_version: 7
   name: "boneIO Black 24x16A"
   version: 0.8
   device_type: "24x16A"
-  
+
 modbus:
   uart: uart4
 
@@ -37,7 +37,12 @@ logger:
   default: info
 
 web:
-  port: 8090 #If you change this you need to change Nginx proxy settings in /home/boneio/docker/
-  proxy_port: 8443
-# adc: !include adc.yaml Uncomment only if needed. Not supported yet in v1.0.0
-
+  # Panel nie jest wystawiony po czystym HTTP na sieć lokalną.
+  #
+  # Wchodzisz na https://<adres_ip>:8443 (certyfikat self-signed, przeglądarka
+  # ostrzeże raz) albo po kablu USB na http://192.168.7.2:8090.
+  # Żeby wrócić do starego zachowania: expose: all
+  #
+  # Port nie jest tu powtórzony — domyślnie i tak jest to 8090.
+  expose: proxy
+# adc: !include adc.yaml

boneio/{example_config → factory_config/0.8}/24x16/mqtt.yaml

@@ -1,6 +1,6 @@
 host: localhost
 username: boneio
-password: boneio123
+password: !secret mqtt_password
 topic_prefix: boneio
 ha_discovery:
   enabled: yes

boneio/factory_config/0.8/24x16/secrets.yaml

@@ -0,0 +1,4 @@
+# Replaced at the controller's first boot by boneio-mqtt-firstboot with a
+# password drawn for this device alone; the broker gets the same one. The
+# factory value below only exists so the image's config validates.
+mqtt_password: boneio123

boneio/{example_config → factory_config/0.8}/32x10/config.yaml

@@ -25,7 +25,7 @@ binary_sensor: !include binary_sensor.yaml
 output: !include output32x10A.yaml
 
 boneio:
-  config_version: 4
+  config_version: 7
   name: "boneIO Black 32x10A"
   version: 0.8
   device_type: "32x10A"
@@ -37,6 +37,12 @@ logger:
   default: info
 
 web:
-  port: 8090 #If you change this you need to change Nginx proxy settings in /home/boneio/docker/
-  proxy_port: 8443
-# adc: !include adc.yaml Uncomment only if needed. Not supported yet in v1.0.0
+  # Panel nie jest wystawiony po czystym HTTP na sieć lokalną.
+  #
+  # Wchodzisz na https://<adres_ip>:8443 (certyfikat self-signed, przeglądarka
+  # ostrzeże raz) albo po kablu USB na http://192.168.7.2:8090.
+  # Żeby wrócić do starego zachowania: expose: all
+  #
+  # Port nie jest tu powtórzony — domyślnie i tak jest to 8090.
+  expose: proxy
+# adc: !include adc.yaml

boneio/{example_config → factory_config/0.8}/32x10/mqtt.yaml

@@ -1,6 +1,6 @@
 host: localhost
 username: boneio
-password: boneio123
+password: !secret mqtt_password
 topic_prefix: boneio
 ha_discovery:
   enabled: yes

boneio/factory_config/0.8/32x10/secrets.yaml

@@ -0,0 +1,4 @@
+# Replaced at the controller's first boot by boneio-mqtt-firstboot with a
+# password drawn for this device alone; the broker gets the same one. The
+# factory value below only exists so the image's config validates.
+mqtt_password: boneio123

boneio/{example_config → factory_config/0.8}/48x4/config.yaml

@@ -25,7 +25,7 @@ binary_sensor: !include binary_sensor.yaml
 output: !include output48x4A.yaml
 
 boneio:
-  config_version: 4
+  config_version: 7
   name: "boneIO Black 48x4A"
   version: 0.8
   device_type: "48x4A"
@@ -37,6 +37,12 @@ logger:
   default: info
 
 web:
-  port: 8090 #If you change this you need to change Nginx proxy settings in /home/boneio/docker/
-  proxy_port: 8443
-# adc: !include adc.yaml Uncomment only if needed. Not supported yet in v1.0.0
+  # Panel nie jest wystawiony po czystym HTTP na sieć lokalną.
+  #
+  # Wchodzisz na https://<adres_ip>:8443 (certyfikat self-signed, przeglądarka
+  # ostrzeże raz) albo po kablu USB na http://192.168.7.2:8090.
+  # Żeby wrócić do starego zachowania: expose: all
+  #
+  # Port nie jest tu powtórzony — domyślnie i tak jest to 8090.
+  expose: proxy
+# adc: !include adc.yaml

boneio/{example_config → factory_config/0.8}/48x4/mqtt.yaml

@@ -1,6 +1,6 @@
 host: localhost
 username: boneio
-password: boneio123
+password: !secret mqtt_password
 topic_prefix: boneio
 ha_discovery:
   enabled: yes

boneio/factory_config/0.8/48x4/secrets.yaml

@@ -0,0 +1,4 @@
+# Replaced at the controller's first boot by boneio-mqtt-firstboot with a
+# password drawn for this device alone; the broker gets the same one. The
+# factory value below only exists so the image's config validates.
+mqtt_password: boneio123

boneio/factory_config/0.8/base/config.yaml

@@ -0,0 +1,42 @@
+mqtt: !include mqtt.yaml
+
+oled:
+  enabled: yes
+  screens:
+    - uptime
+    - network
+    - cpu
+    - disk
+    - memory
+    - swap
+    - web
+
+lm75:
+  - id: Board temperature
+    address: 0x48
+ina219:
+  - address: 0x40
+
+
+
+boneio:
+  config_version: 7
+  name: "boneIO Black"
+  version: 0.8
+
+modbus:
+  uart: uart4
+
+logger:
+  default: info
+
+web:
+  # Panel nie jest wystawiony po czystym HTTP na sieć lokalną.
+  #
+  # Wchodzisz na https://<adres_ip>:8443 (certyfikat self-signed, przeglądarka
+  # ostrzeże raz) albo po kablu USB na http://192.168.7.2:8090.
+  # Żeby wrócić do starego zachowania: expose: all
+  #
+  # Port nie jest tu powtórzony — domyślnie i tak jest to 8090.
+  expose: proxy
+# adc: !include adc.yaml

boneio/{example_config/cover → factory_config/0.8/base}/mqtt.yaml

@@ -1,6 +1,6 @@
 host: localhost
 username: boneio
-password: boneio123
+password: !secret mqtt_password
 topic_prefix: boneio
 ha_discovery:
   enabled: yes

boneio/factory_config/0.8/base/secrets.yaml

@@ -0,0 +1,4 @@
+# Replaced at the controller's first boot by boneio-mqtt-firstboot with a
+# password drawn for this device alone; the broker gets the same one. The
+# factory value below only exists so the image's config validates.
+mqtt_password: boneio123

boneio/{example_config → factory_config/0.8}/cover/config.yaml

@@ -26,11 +26,11 @@ output: !include outputCover.yaml
 cover: !include cover.yaml
 
 boneio:
-  config_version: 4
+  config_version: 7
   name: "boneIO Black Cover"
   version: 0.8
   device_type: "cover"
-  
+
 modbus:
   uart: uart4
 
@@ -38,6 +38,12 @@ logger:
   default: info
 
 web:
-  port: 8090 #If you change this you need to change Nginx proxy settings in /home/boneio/docker/
-  proxy_port: 8443
-# adc: !include adc.yaml Uncomment only if needed. Not supported yet in v1.0.0
+  # Panel nie jest wystawiony po czystym HTTP na sieć lokalną.
+  #
+  # Wchodzisz na https://<adres_ip>:8443 (certyfikat self-signed, przeglądarka
+  # ostrzeże raz) albo po kablu USB na http://192.168.7.2:8090.
+  # Żeby wrócić do starego zachowania: expose: all
+  #
+  # Port nie jest tu powtórzony — domyślnie i tak jest to 8090.
+  expose: proxy
+# adc: !include adc.yaml

boneio/factory_config/0.8/cover/mqtt.yaml

@@ -0,0 +1,6 @@
+host: localhost
+username: boneio
+password: !secret mqtt_password
+topic_prefix: boneio
+ha_discovery:
+  enabled: yes

boneio/factory_config/0.8/cover/secrets.yaml

@@ -0,0 +1,4 @@
+# Replaced at the controller's first boot by boneio-mqtt-firstboot with a
+# password drawn for this device alone; the broker gets the same one. The
+# factory value below only exists so the image's config validates.
+mqtt_password: boneio123

boneio/{example_config → factory_config/0.8}/cover_mix/config.yaml

@@ -26,11 +26,11 @@ output: !include outputCoverMix.yaml
 cover: !include cover.yaml
 
 boneio:
-  config_version: 4
+  config_version: 7
   name: "boneIO Black Cover Mix"
   version: 0.8
   device_type: "Cover Mix"
-  
+
 modbus:
   uart: uart4
 
@@ -38,6 +38,12 @@ logger:
   default: info
 
 web:
-  port: 8090 #If you change this you need to change Nginx proxy settings in /home/boneio/docker/
-  proxy_port: 8443
-# adc: !include adc.yaml Uncomment only if needed. Not supported yet in v1.0.0
+  # Panel nie jest wystawiony po czystym HTTP na sieć lokalną.
+  #
+  # Wchodzisz na https://<adres_ip>:8443 (certyfikat self-signed, przeglądarka
+  # ostrzeże raz) albo po kablu USB na http://192.168.7.2:8090.
+  # Żeby wrócić do starego zachowania: expose: all
+  #
+  # Port nie jest tu powtórzony — domyślnie i tak jest to 8090.
+  expose: proxy
+# adc: !include adc.yaml

boneio/factory_config/0.8/cover_mix/mqtt.yaml

@@ -0,0 +1,6 @@
+host: localhost
+username: boneio
+password: !secret mqtt_password
+topic_prefix: boneio
+ha_discovery:
+  enabled: yes

boneio/factory_config/0.8/cover_mix/secrets.yaml

@@ -0,0 +1,4 @@
+# Replaced at the controller's first boot by boneio-mqtt-firstboot with a
+# password drawn for this device alone; the broker gets the same one. The
+# factory value below only exists so the image's config validates.
+mqtt_password: boneio123

boneio/factory_config/1.0/24x16/adc.yaml

@@ -0,0 +1,14 @@
+- name: adc1
+  pin: P9_33
+- name: adc2
+  pin: P9_36
+- name: adc3
+  pin: P9_35
+- name: adc4
+  pin: P9_38
+- name: adc5
+  pin: P9_37
+- name: adc6
+  pin: P9_40
+- name: adc7
+  pin: P9_39

boneio/factory_config/1.0/24x16/binary_sensor.yaml

@@ -0,0 +1,17 @@
+## Default config for binary sensor entities.
+# Binary sensor entities send on/off message to Home Assistant and run on pressed and released action.
+# PINs are shared between event.yaml and binary_sensor.yaml.
+# Don't duplicate PINs.
+
+- name: IN_48
+  boneio_input: in_48
+  actions:
+    pressed:
+      - action: output
+        boneio_output: OUT_01
+- name: IN_49
+  boneio_input: in_49
+  actions:
+    pressed:
+      - action: output
+        boneio_output: OUT_02