Skip to content

Commit 797dace

Browse files
nomis52nomis52
committed
Add instructions.
1 parent b357a2c commit 797dace

8 files changed

+107
-0
lines changed

‎Makefile.am

+4
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ include tools/Makefile.mk
3838
include user_manual/Makefile.mk
3939

4040
check_PROGRAMS = $(TESTS)
41+
42+
doc-gen: user_manual/pid_gen/pid_gen
43+
./user_manual/pid_gen/pid_gen --output-dir user_manual/gen
44+

‎user_manual/gen/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
To re-generate the files in this directory run
2+
3+
$ make doc-gen
4+
5+
from the root ja-rule directory.

‎user_manual/gen/dimmer.html

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<table class="doxtable"><tr><th>PID</th><th>Get</th><th>Set</th></tr>
2+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=48">STATUS_MESSAGES</a></td><td>Y</td><td></td></tr>
3+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=49">STATUS_ID_DESCRIPTION</a></td><td>Y</td><td></td></tr>
4+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=112">PRODUCT_DETAIL_ID_LIST</a></td><td>Y</td><td></td></tr>
5+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=128">DEVICE_MODEL_DESCRIPTION</a></td><td>Y</td><td></td></tr>
6+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=129">MANUFACTURER_LABEL</a></td><td>Y</td><td></td></tr>
7+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=130">DEVICE_LABEL</a></td><td>Y</td><td>Y</td></tr>
8+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=320">DMX_BLOCK_ADDRESS</a></td><td>Y</td><td>Y</td></tr>
9+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=321">DMX_FAIL_MODE</a></td><td>Y</td><td>Y</td></tr>
10+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=322">DMX_STARTUP_MODE</a></td><td>Y</td><td>Y</td></tr>
11+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1600">LOCK_PIN</a></td><td>Y</td><td>Y</td></tr>
12+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1601">LOCK_STATE</a></td><td>Y</td><td>Y</td></tr>
13+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1602">LOCK_STATE_DESCRIPTION</a></td><td>Y</td><td></td></tr>
14+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4128">PERFORM_SELFTEST</a></td><td>Y</td><td>Y</td></tr>
15+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4129">SELF_TEST_DESCRIPTION</a></td><td>Y</td><td></td></tr>
16+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4144">CAPTURE_PRESET</a></td><td></td><td>Y</td></tr>
17+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4145">PRESET_PLAYBACK</a></td><td>Y</td><td>Y</td></tr>
18+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4161">PRESET_INFO</a></td><td>Y</td><td></td></tr>
19+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4162">PRESET_STATUS</a></td><td>Y</td><td>Y</td></tr>
20+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4163">PRESET_MERGEMODE</a></td><td>Y</td><td>Y</td></tr>
21+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4164">POWER_ON_SELF_TEST</a></td><td>Y</td><td>Y</td></tr>
22+
</table>

‎user_manual/gen/led.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<table class="doxtable"><tr><th>PID</th><th>Get</th><th>Set</th></tr>
2+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=112">PRODUCT_DETAIL_ID_LIST</a></td><td>Y</td><td></td></tr>
3+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=128">DEVICE_MODEL_DESCRIPTION</a></td><td>Y</td><td></td></tr>
4+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=129">MANUFACTURER_LABEL</a></td><td>Y</td><td></td></tr>
5+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=130">DEVICE_LABEL</a></td><td>Y</td><td>Y</td></tr>
6+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=31344&pid=32773">PIXEL_TYPE</a></td><td>Y</td><td>Y</td></tr>
7+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=31344&pid=32774">PIXEL_COUNT</a></td><td>Y</td><td>Y</td></tr>
8+
</table>

‎user_manual/gen/moving_light.html

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<table class="doxtable"><tr><th>PID</th><th>Get</th><th>Set</th></tr>
2+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=21">COMMS_STATUS</a></td><td>Y</td><td>Y</td></tr>
3+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=112">PRODUCT_DETAIL_ID_LIST</a></td><td>Y</td><td></td></tr>
4+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=128">DEVICE_MODEL_DESCRIPTION</a></td><td>Y</td><td></td></tr>
5+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=129">MANUFACTURER_LABEL</a></td><td>Y</td><td></td></tr>
6+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=130">DEVICE_LABEL</a></td><td>Y</td><td>Y</td></tr>
7+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=144">FACTORY_DEFAULTS</a></td><td>Y</td><td>Y</td></tr>
8+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=160">LANGUAGE_CAPABILITIES</a></td><td>Y</td><td></td></tr>
9+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=176">LANGUAGE</a></td><td>Y</td><td>Y</td></tr>
10+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=193">BOOT_SOFTWARE_VERSION_ID</a></td><td>Y</td><td></td></tr>
11+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=194">BOOT_SOFTWARE_VERSION_LABEL</a></td><td>Y</td><td></td></tr>
12+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=224">DMX_PERSONALITY</a></td><td>Y</td><td>Y</td></tr>
13+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=225">DMX_PERSONALITY_DESCRIPTION</a></td><td>Y</td><td></td></tr>
14+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=288">SLOT_INFO</a></td><td>Y</td><td></td></tr>
15+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=289">SLOT_DESCRIPTION</a></td><td>Y</td><td></td></tr>
16+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=290">DEFAULT_SLOT_VALUE</a></td><td>Y</td><td></td></tr>
17+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1024">DEVICE_HOURS</a></td><td>Y</td><td>Y</td></tr>
18+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1025">LAMP_HOURS</a></td><td>Y</td><td>Y</td></tr>
19+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1026">LAMP_STRIKES</a></td><td>Y</td><td>Y</td></tr>
20+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1027">LAMP_STATE</a></td><td>Y</td><td>Y</td></tr>
21+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1028">LAMP_ON_MODE</a></td><td>Y</td><td>Y</td></tr>
22+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1029">DEVICE_POWER_CYCLES</a></td><td>Y</td><td>Y</td></tr>
23+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1280">DISPLAY_INVERT</a></td><td>Y</td><td>Y</td></tr>
24+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1281">DISPLAY_LEVEL</a></td><td>Y</td><td>Y</td></tr>
25+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1536">PAN_INVERT</a></td><td>Y</td><td>Y</td></tr>
26+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1537">TILT_INVERT</a></td><td>Y</td><td>Y</td></tr>
27+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1538">PAN_TILT_SWAP</a></td><td>Y</td><td>Y</td></tr>
28+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1539">REAL_TIME_CLOCK</a></td><td>Y</td><td>Y</td></tr>
29+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4097">RESET_DEVICE</a></td><td></td><td>Y</td></tr>
30+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=4112">POWER_STATE</a></td><td>Y</td><td>Y</td></tr>
31+
</table>

‎user_manual/gen/network.html

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<table class="doxtable"><tr><th>PID</th><th>Get</th><th>Set</th></tr>
2+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=112">PRODUCT_DETAIL_ID_LIST</a></td><td>Y</td><td></td></tr>
3+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=128">DEVICE_MODEL_DESCRIPTION</a></td><td>Y</td><td></td></tr>
4+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=129">MANUFACTURER_LABEL</a></td><td>Y</td><td></td></tr>
5+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=130">DEVICE_LABEL</a></td><td>Y</td><td>Y</td></tr>
6+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1792">LIST_INTERFACES</a></td><td>Y</td><td></td></tr>
7+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1793">INTERFACE_LABEL</a></td><td>Y</td><td></td></tr>
8+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1794">INTERFACE_HARDWARE_ADDRESS_TYPE1</a></td><td>Y</td><td></td></tr>
9+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1795">IPV4_DHCP_MODE</a></td><td>Y</td><td>Y</td></tr>
10+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1796">IPV4_ZEROCONF_MODE</a></td><td>Y</td><td>Y</td></tr>
11+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1797">IPV4_CURRENT_ADDRESS</a></td><td>Y</td><td></td></tr>
12+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1798">IPV4_STATIC_ADDRESS</a></td><td>Y</td><td>Y</td></tr>
13+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1799">INTERFACE_RENEW_DHCP</a></td><td></td><td>Y</td></tr>
14+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1800">INTERFACE_RELEASE_DHCP</a></td><td></td><td>Y</td></tr>
15+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1801">INTERFACE_APPLY_CONFIGURATION</a></td><td></td><td>Y</td></tr>
16+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1802">IPV4_DEFAULT_ROUTE</a></td><td>Y</td><td>Y</td></tr>
17+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1803">DNS_IPV4_NAME_SERVER</a></td><td>Y</td><td>Y</td></tr>
18+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1804">DNS_HOSTNAME</a></td><td>Y</td><td>Y</td></tr>
19+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=1805">DNS_DOMAIN_NAME</a></td><td>Y</td><td>Y</td></tr>
20+
</table>

‎user_manual/gen/proxy.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<table class="doxtable"><tr><th>PID</th><th>Get</th><th>Set</th></tr>
2+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=16">PROXIED_DEVICES</a></td><td>Y</td><td></td></tr>
3+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=17">PROXIED_DEVICE_COUNT</a></td><td>Y</td><td></td></tr>
4+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=112">PRODUCT_DETAIL_ID_LIST</a></td><td>Y</td><td></td></tr>
5+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=128">DEVICE_MODEL_DESCRIPTION</a></td><td>Y</td><td></td></tr>
6+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=129">MANUFACTURER_LABEL</a></td><td>Y</td><td></td></tr>
7+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=130">DEVICE_LABEL</a></td><td>Y</td><td>Y</td></tr>
8+
</table>

‎user_manual/gen/sensor.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<table class="doxtable"><tr><th>PID</th><th>Get</th><th>Set</th></tr>
2+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=112">PRODUCT_DETAIL_ID_LIST</a></td><td>Y</td><td></td></tr>
3+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=128">DEVICE_MODEL_DESCRIPTION</a></td><td>Y</td><td></td></tr>
4+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=129">MANUFACTURER_LABEL</a></td><td>Y</td><td></td></tr>
5+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=130">DEVICE_LABEL</a></td><td>Y</td><td>Y</td></tr>
6+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=512">SENSOR_DEFINITION</a></td><td>Y</td><td></td></tr>
7+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=513">SENSOR_VALUE</a></td><td>Y</td><td>Y</td></tr>
8+
<tr><td><a href="http://rdm.openlighting.org/pid/display?manufacturer=0&pid=514">RECORD_SENSORS</a></td><td></td><td>Y</td></tr>
9+
</table>

0 commit comments

Comments
 (0)