autocamlight 0.1.0__tar.gz

autocamlight-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dries007
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

autocamlight-0.1.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: autocamlight
+Version: 0.1.0
+Summary: Automate your webcam light.
+Author: Dries007
+Author-email: Dries007 <admin@dries007.net>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: ha-mqtt-discoverable>=0.22.1
+Requires-Dist: inotify>=0.2.12
+Requires-Dist: pydantic-settings>=2.11.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# AutoCamLight
+
+    ╔═══╗    ╖      ╔═══╕         ╖         ╖   ╖   
+    ║   ║    ║      ║             ║    °    ║   ║   
+    ╠═══╣╖  ╓╠═╛╔══╗║    ╒══╗╔═╦═╗║    ╖╔══╗╠══╗╠═╛ 
+    ║   ║║  ║║  ║  ║║    ╔══╣║ ║ ║║    ║║  ║║  ║║   
+    ╜   ╙╚══╝╚═╛╚══╝╚═══╛╚══╝╜ ╙ ╙╚═══╛╙╚══╣╜  ╙╚═╛ 
+                                        ╓  ║        
+    AutoCamLight                        ╚══╝        
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI version](https://badge.fury.io/py/autocamlight.svg)](https://badge.fury.io/py/autocamlight)
+
+
+A small linux utility to automate your webcam light via Home Assistant.
+
+Monitors /dev/video* and sends a state update to HA via MQTT when it detects that video is being captured.      
+
+## Usage
+
+Install, configure and run in the background.
+
+After the first time the webcam is used, the device & entity will be created in Home Assistant, so you can set up your automations.
+
+### Install
+    
+Use of [uv](https://docs.astral.sh/uv/) is highly recommended:
+
+```shell
+uv tool install autocamlight
+```
+
+### Configure
+
+Create a `autocamlight.toml` file in one of the following locations: 
+
+1. $XDG_CONFIG_HOME (or ~/.config if unset), or
+2. $XDG_CONFIG_DIRS (or /etc/xdg if unset), read as a list of folder split by :, as per the XDG specification, or
+3. the current working directory.
+
+Only a single toml file is loaded.
+
+Example configuration:
+
+```toml
+log_level = "DEBUG"
+
+[mqtt]
+host = "homeassistant.local"
+username = "mqtt"
+password = "Correct Horse Battery Staple"
+
+[entity]
+name = "Webcam"
+unique_id = "fe4bd497-7c2f-4f35-899f-f147f9f84738-capturing"
+
+[entity.device]
+name = "Webcam"
+identifiers = "fe4bd497-7c2f-4f35-899f-f147f9f84738"
+```
+
+The file structure is dictated mostly by [ha_mqtt_discoverable](https://github.com/unixorn/ha-mqtt-discoverable).
+
+
+### Auto-run on login
+
+Create a new (user) unit file:
+
+```shell
+systemctl --user --force --full edit autocamlight
+```
+
+Add the following to the file, assuming uv is installed in /usr/bin:
+
+```ini
+[Unit]
+Description=AutoCamLight
+After=multi-user.target
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/uv tool run autocamlight
+Restart=on-failure
+RestartSec=5
+Environment=PYTHONUNBUFFERED=1
+
+[Install]
+WantedBy=default.target
+```
+
+Now enable & start the unit:
+
+```shell
+systemctl --user enable autocamlight
+systemctl --user start autocamlight
+```
+
+You can monitor the service status with:
+
+```bash
+systemctl --user status autocamlight
+journalctl --user -u autocamlight -f
+```
+
+### Test
+
+Open any program that uses the webcam, e.g. Cheese.
+
+If you have the logs open, an INFO message should appear.
+The entity should be created in Home Assistant.

autocamlight-0.1.0/README.md

@@ -0,0 +1,110 @@
+# AutoCamLight
+
+    ╔═══╗    ╖      ╔═══╕         ╖         ╖   ╖   
+    ║   ║    ║      ║             ║    °    ║   ║   
+    ╠═══╣╖  ╓╠═╛╔══╗║    ╒══╗╔═╦═╗║    ╖╔══╗╠══╗╠═╛ 
+    ║   ║║  ║║  ║  ║║    ╔══╣║ ║ ║║    ║║  ║║  ║║   
+    ╜   ╙╚══╝╚═╛╚══╝╚═══╛╚══╝╜ ╙ ╙╚═══╛╙╚══╣╜  ╙╚═╛ 
+                                        ╓  ║        
+    AutoCamLight                        ╚══╝        
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI version](https://badge.fury.io/py/autocamlight.svg)](https://badge.fury.io/py/autocamlight)
+
+
+A small linux utility to automate your webcam light via Home Assistant.
+
+Monitors /dev/video* and sends a state update to HA via MQTT when it detects that video is being captured.      
+
+## Usage
+
+Install, configure and run in the background.
+
+After the first time the webcam is used, the device & entity will be created in Home Assistant, so you can set up your automations.
+
+### Install
+    
+Use of [uv](https://docs.astral.sh/uv/) is highly recommended:
+
+```shell
+uv tool install autocamlight
+```
+
+### Configure
+
+Create a `autocamlight.toml` file in one of the following locations: 
+
+1. $XDG_CONFIG_HOME (or ~/.config if unset), or
+2. $XDG_CONFIG_DIRS (or /etc/xdg if unset), read as a list of folder split by :, as per the XDG specification, or
+3. the current working directory.
+
+Only a single toml file is loaded.
+
+Example configuration:
+
+```toml
+log_level = "DEBUG"
+
+[mqtt]
+host = "homeassistant.local"
+username = "mqtt"
+password = "Correct Horse Battery Staple"
+
+[entity]
+name = "Webcam"
+unique_id = "fe4bd497-7c2f-4f35-899f-f147f9f84738-capturing"
+
+[entity.device]
+name = "Webcam"
+identifiers = "fe4bd497-7c2f-4f35-899f-f147f9f84738"
+```
+
+The file structure is dictated mostly by [ha_mqtt_discoverable](https://github.com/unixorn/ha-mqtt-discoverable).
+
+
+### Auto-run on login
+
+Create a new (user) unit file:
+
+```shell
+systemctl --user --force --full edit autocamlight
+```
+
+Add the following to the file, assuming uv is installed in /usr/bin:
+
+```ini
+[Unit]
+Description=AutoCamLight
+After=multi-user.target
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/uv tool run autocamlight
+Restart=on-failure
+RestartSec=5
+Environment=PYTHONUNBUFFERED=1
+
+[Install]
+WantedBy=default.target
+```
+
+Now enable & start the unit:
+
+```shell
+systemctl --user enable autocamlight
+systemctl --user start autocamlight
+```
+
+You can monitor the service status with:
+
+```bash
+systemctl --user status autocamlight
+journalctl --user -u autocamlight -f
+```
+
+### Test
+
+Open any program that uses the webcam, e.g. Cheese.
+
+If you have the logs open, an INFO message should appear.
+The entity should be created in Home Assistant.

autocamlight-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["uv_build>=0.8.15,<0.9.0"]
+build-backend = "uv_build"
+
+[project]
+name = "autocamlight"
+version = "0.1.0"
+readme = "README.md"
+description = "Automate your webcam light."
+authors = [
+    {name = "Dries007", email = "admin@dries007.net"},
+]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = [
+    "ha-mqtt-discoverable>=0.22.1",
+    "inotify>=0.2.12",
+    "pydantic-settings>=2.11.0",
+]
+
+[project.scripts]
+autocamlight = "autocamlight.__main__:main"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.3.0",
+    "ruff>=0.14.0",
+]
+
+#  ___       __  __
+# | _ \_  _ / _|/ _|
+# |   / || |  _|  _|
+# |_|_\\_,_|_| |_|
+[tool.ruff]
+line-length = 140
+fix = true
+
+[tool.ruff.lint]
+# Add extra checks to default. See https://docs.astral.sh/ruff/rules/
+extend-select = [
+    "F",  # pyflakes
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "G",  # flake8-logging
+    "UP",  # pyupgrade
+    "PT",  # flake8-pytest-style
+    "SIM",  # flake8-simplify
+    "ISC",  # flake8-implicit-str-concat
+    "PIE",  # flake8-pie
+    "FLY",  # flynt
+    "PERF",  # perflint
+    "FURB",  # refurb
+    "RUF",  # ruff
+]
+ignore = [
+    "E501",  # line-too-long, ignored because the formatter has some leeway this rule doesn't understand
+]
+
+[tool.ruff.format]
+docstring-code-format = true

autocamlight-0.1.0/src/autocamlight/__init__.py

@@ -0,0 +1,120 @@
+import logging
+import os
+import signal
+from pathlib import Path
+from threading import Timer
+from typing import Literal
+
+from ha_mqtt_discoverable import Settings
+from ha_mqtt_discoverable.sensors import BinarySensor, BinarySensorInfo
+from inotify.adapters import Inotify
+from inotify.constants import IN_CLOSE, IN_OPEN
+from pydantic import ValidationError
+from pydantic_settings import BaseSettings, PydanticBaseSettingsSource, SettingsConfigDict, TomlConfigSettingsSource
+
+
+LOGO = r'''
+╔═══╗    ╖      ╔═══╕         ╖         ╖   ╖   
+║   ║    ║      ║             ║    °    ║   ║   
+╠═══╣╖  ╓╠═╛╔══╗║    ╒══╗╔═╦═╗║    ╖╔══╗╠══╗╠═╛ 
+║   ║║  ║║  ║  ║║    ╔══╣║ ║ ║║    ║║  ║║  ║║   
+╜   ╙╚══╝╚═╛╚══╝╚═══╛╚══╝╜ ╙ ╙╚═══╛╙╚══╣╜  ╙╚═╛ 
+                                    ╓  ║        
+AutoCamLight                        ╚══╝        
+'''
+
+
+def possible_config_files():
+    for folder in (
+        os.environ.get("XDG_CONFIG_HOME", os.environ["HOME"] + "/.config"),
+        *os.environ.get("XDG_CONFIG_DIRS", "/etc/xdg").split(':'),
+        '.'
+    ):
+        yield Path(folder, "autocamlight.toml").resolve()
+
+
+class Config(BaseSettings):
+    model_config = SettingsConfigDict(toml_file=list(possible_config_files()))
+
+    log_level: Literal["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"] = "INFO"
+
+    mqtt: Settings.MQTT
+    entity: BinarySensorInfo
+
+    @classmethod
+    def settings_customise_sources(cls, settings_cls: type[BaseSettings], *args, **kwargs) -> tuple[PydanticBaseSettingsSource, ...]:
+        return (TomlConfigSettingsSource(settings_cls),)
+
+    @classmethod
+    def load(cls):
+        try:
+            # noinspection PyArgumentList
+            return cls()
+        except ValidationError as e:
+            print("Tried to load these files:", ', '.join(map(os.fspath, cls.model_config.get("toml_file"))))
+            print("Could not load config, please check your config file. Pydantic error:")
+            print(e)
+            exit(1)
+
+
+
+class AutoCamLight:
+    def __init__(self, cfg: Config):
+        self._state = None
+        self._cfg = cfg
+        self.sensor = BinarySensor(Settings(mqtt=cfg.mqtt, entity=cfg.entity, manual_availability=True))
+
+    def run(self):
+        try:
+            self.sensor.set_availability(True)
+            inotify = Inotify()
+
+            inotify.add_watch('/dev', mask=IN_OPEN | IN_CLOSE)
+
+            debounce = Timer(0, lambda: None)
+
+            for header, _, _, filename in inotify.event_gen(yield_nones=False):
+                if not filename.startswith('video'):
+                    continue
+
+                debounce.cancel()
+                debounce = Timer(0.1, self.set_state, (bool(header.mask & IN_OPEN), ))
+                debounce.start()
+        except KeyboardInterrupt:
+            pass
+        finally:
+            logger = logging.getLogger("autocamlight")
+            logger.info("Exiting...")
+            # noinspection PyBroadException
+            try:
+                self.sensor.set_availability(False)
+            except Exception:
+                logger.exception("Failed to set availability")
+            # noinspection PyBroadException
+            try:
+                self.sensor.mqtt_client.disconnect()
+            except Exception:
+                logger.exception("Failed to disconnect MQTT client")
+                pass
+
+
+    def set_state(self, state: bool):
+        if state == self._state:
+            return
+        self._state = state
+
+        self.sensor.update_state(state)
+
+
+def main():
+    signal.signal(signal.SIGTERM, lambda signal, frame: exit(0))
+
+    cfg = Config.load()
+
+    logging.basicConfig(level=cfg.log_level, format="%(asctime)s %(levelname)5s [%(name)s] %(message)s")
+    logger = logging.getLogger("autocamlight")
+    logger.info(LOGO)
+    logger.info("Loaded config:\n%s", cfg.model_dump_json(indent=2, exclude_defaults=True))
+
+    acl = AutoCamLight(cfg)
+    acl.run()

autocamlight-0.1.0/src/autocamlight/__main__.py

@@ -0,0 +1,4 @@
+from . import main
+
+if __name__ == '__main__':
+    main()