Add new features

.pre-commit-config.yaml

@@ -1,6 +1,12 @@
 repos:
-- repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.6.7
-  hooks:
-    - id: ruff
-    - id: ruff-format
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.7
+    hooks:
+      - id: ruff
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0 # Use the latest version
+    hooks:
+      - id: mypy
+        files: ^jvcprojector/
+        args: [--namespace-packages, --explicit-package-bases, --ignore-missing-imports ]

Makefile

@@ -1,8 +1,19 @@
 all: clean build
 
 build:
+	rm -rf dist
 	python3 -m build
 	python -m twine upload -u __token__ dist/*
 
+dev-setup:
+	python -m venv .venv && \
+	. .venv/bin/activate && \
+	pip install -r requirements_dev.txt && \
+	pip install -r requirements.txt && \
+	echo "Dev setup complete. Run 'source .venv/bin/activate' to activate the virtual environment and pre-commit install."
+
 clean:
-	rm -rf dist
+	rm -rf dist
+
+test:
+	coverage run --source jvcprojector --module pytest && coverage report --show-missing

README.md

@@ -9,15 +9,23 @@ https://pypi.org/project/pyjvcprojector/
 A full reference to the available commands is available from JVC here
 http://pro.jvc.com/pro/attributes/PRESENT/Manual/External%20Command%20Spec%20for%20D-ILA%20projector_V3.0.pdf.
 
+### Commands
+* `JvcCommandHelpers.get_available_commands()` return an object containing all available commands.
+* `JvcCommandHelpers.get_command_help("picture_mode")` return human readable help for a given command.
+
 ### Convenience functions:
 * `JvcProjector::power_on()` turns on power.
 * `JvcProjector::power_off()` turns off power.
 * `JvcProjector::get_power()` gets power state (_standby, on, cooling, warming, error_)
+* `JvcProjector::is_on()` returns True if the power is on and ready
 * `JvcProjector::get_input()` get current input (_hdmi1, hdmi2_).
 * `JvcProjector::get_signal()` get signal state (_signal, nosignal_).
 * `JvcProjector::get_state()` returns {_power, input, signal_}.
 * `JvcProjector::get_info()` returns {_model, mac address_}.
 
+### Send supported commands
+* `JvcProjector::send_command(cmd, val)` where cmd is a top level key from `JvcCommandHelpers.get_available_commands()` such as `laser_power` and val is a valid option found in the `values` key. For example, `clear_motion_drive, low`.
+
 ### Send remote control codes
 A wrapper for calling `JvcProjector::op(f"RC{code}")`
 * `JvcProjector::remote(code)` sends remote control command.
@@ -48,10 +56,10 @@ async def main():
     print("Projector info:")
     print(await jp.get_info())
 
-    if await jp.get_power() != const.ON:
+    if not await jp.is_on():
         await jp.power_on()
         print("Waiting for projector to warmup...")
-        while await jp.get_power() != const.ON:
+        while not await jp.is_on():
             await asyncio.sleep(3)
 
     print("Current state:")
@@ -74,9 +82,9 @@ async def main():
     print(await jp.ref("PMPM"))
 
     #
-    # Example sending operation command (writes value to function)
+    # Example sending operation command
     #
-    # await jp.ref("PMPM01")  # Sets picture mode to Film
+    await jp.send_command(const.CMD_PICTURE_MODE_LASER_POWER, const.VAL_LASER_POWER[1])
 
     await jp.disconnect()
 ```

examples/__init__.py

@@ -0,0 +1 @@
+# type: ignore

examples/simple.py

@@ -1,3 +1,6 @@
+# type: ignore
+"""simple example"""
+
 import asyncio
 import logging
 
@@ -14,10 +17,10 @@ async def main():
     print("Projector info:")
     print(await jp.get_info())
 
-    if await jp.get_power() != const.ON:
+    if not await jp.is_on():
         await jp.power_on()
         print("Waiting for projector to warmup...")
-        while await jp.get_power() != const.ON:
+        while not await jp.is_on():
             await asyncio.sleep(3)
 
     print("Current state:")

jvcprojector/__init__.py

@@ -2,12 +2,4 @@
 
 # ruff: noqa: F401
 
-from .error import (
-    JvcProjectorAuthError,
-    JvcProjectorCommandError,
-    JvcProjectorConnectError,
-    JvcProjectorError,
-)
-from .projector import JvcProjector
-
 __version__ = "1.1.2"