device-drivers/Makefile at main · srcfl/device-drivers · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
ID ?=
PROTOCOL ?= modbus
KIND ?= meter
TARGET ?= ftw-core
ARTIFACT_DIR ?= .artifacts/$(ID)

LEVEL ?= patch

.PHONY: bootstrap new-driver test-driver package-driver check boundary \
	refused-write-report absent-register-report \
	sync-manifests bump-driver history ftw-baseline ftw-baseline-report \
	host-api site watch-upstream-docs

# Build the public driver catalog page into site/, exactly as GitHub Pages
# publishes it. Open site/index.html to review a change before it ships.
site:
	uv run --frozen --extra package --extra dev python tools/generate_site.py --output site

# Does any driver call a host function no host provides?
host-api:
	uv run --frozen --extra package --extra dev python tools/host_api_check.py


# Re-import FTW's bundled drivers into baselines/ftw. Needs the GitHub API.
ftw-baseline:
	uv run --frozen --extra package --extra dev python tools/import_ftw_baseline.py

# Show what stands between each FTW baseline and a catalog driver.
ftw-baseline-report:
	uv run --frozen --extra package --extra dev python tools/import_ftw_baseline.py --report

# Which registers a driver reads forever while still reporting telemetry.
# Every one takes the driver offline on hardware that omits that register.
absent-register-report:
	test -n "$(ID)"
	./lua55 drivers/tests/lua_harness/absent_register_probe.lua . "drivers/lua/$(ID).lua"

# Does this driver keep writing a register the device refuses? The watchdog
# reaches driver_default_mode on a timer, so anything but a settled count
# repeats for the life of the session.
refused-write-report:
	test -n "$(ID)"
	./lua55 drivers/tests/lua_harness/refused_write_probe.lua . "drivers/lua/$(ID).lua"

bootstrap:
	uv sync --frozen --extra package --extra dev

new-driver:
	uv run --frozen --extra package --extra dev python tools/new_driver.py --id "$(ID)" --protocol "$(PROTOCOL)" --kind "$(KIND)"

test-driver:
	test -n "$(ID)"
	bash tools/build_luac.sh --with-interpreter ./luac55
	./luac55 -p "drivers/lua/$(ID).lua"
	bash tools/check_sandbox.sh "drivers/lua/$(ID).lua"
	uv run --frozen --extra package --extra dev python tools/validate_manifest.py "manifests/$(ID).yaml"
	uv run --frozen --extra package --extra dev pytest -q drivers/tests -k "$(ID)"

package-driver:
	test -n "$(ID)"
	uv run --frozen --extra package --extra dev python tools/build_candidate.py --id "$(ID)" --target "$(TARGET)" --output-dir "$(ARTIFACT_DIR)"

boundary:
	uv run --frozen --extra package --extra dev python tools/check_public_boundary.py

# Rewrite sha256 and size_bytes in every manifest from the Lua source.
sync-manifests:
	uv run --frozen --extra package --extra dev python tools/sync_manifests.py

# Fetch every manifest upstream_docs URL and report changes against the
# baseline WITHOUT rewriting it. The scheduled watch-upstream-docs workflow
# runs the same tool for real and opens a tracking issue on a change.
watch-upstream-docs:
	uv run --frozen --extra package --extra dev python tools/check_upstream_docs.py --dry-run

# Raise a driver version in the manifest and the DRIVER table together.
# Example: make bump-driver ID=sungrow LEVEL=patch
bump-driver:
	test -n "$(ID)"
	uv run --frozen --extra package --extra dev python tools/bump_driver.py --id "$(ID)" --level "$(LEVEL)"
	uv run --frozen --extra package --extra dev python tools/sync_manifests.py --id "$(ID)"
	uv run --frozen --extra package --extra dev python tools/generate_index.py
	uv run --frozen --extra package --extra dev python tools/generate_devices.py
	uv run --frozen --extra package --extra dev python tools/generate_support_status.py

# Record newly published driver versions in driver-history.json.
history:
	uv run --frozen --extra package --extra dev python tools/generate_history.py

check: boundary
	bash tools/build_luac.sh --with-interpreter ./luac55
	uv run --frozen --extra package --extra dev python tools/sync_manifests.py
	git diff --exit-code -- manifests
	uv run --frozen --extra package --extra dev python tools/validate_manifest.py
	uv run --frozen --extra package --extra dev python tools/generate_index.py
	git diff --exit-code -- index.yaml
	uv run --frozen --extra package --extra dev python tools/generate_devices.py
	git diff --exit-code -- devices.yaml
	uv run --frozen --extra package --extra dev python tools/generate_support_status.py
	git diff --exit-code -- support-status.json SUPPORT_STATUS.md
	uv run --frozen --extra package --extra dev python tools/generate_history.py --check
	uv run --frozen --extra package --extra dev python tools/import_ftw_baseline.py --check
	uv run --frozen --extra package --extra dev python tools/host_api_check.py --check
	bash tools/check_sandbox.sh
	uv run --frozen --extra package --extra dev pytest -q drivers/tests tests