Difference between revisions of "Lighting Automation/Control Software"
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ===Command structure=== | |
| − | |||
This is based around posible commands we want to issue.<br /> | This is based around posible commands we want to issue.<br /> | ||
There is a total of 11 rooms and 17 zones.<br /> | There is a total of 11 rooms and 17 zones.<br /> | ||
| Line 16: | Line 15: | ||
Internally the control box firmware will have to track state of each zone it's in charge of.<br /> | Internally the control box firmware will have to track state of each zone it's in charge of.<br /> | ||
| − | + | ===MQTT Commands=== | |
| + | Based around the following MQTT topic structure | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Topic | ||
| + | ! Description | ||
| + | ! Notes | ||
| + | |- | ||
| + | | nh/li/set/ROOM/ZONE || Lighting Command || ROOM(lowercase) is one of the pre defined rooms ZONE within a ROOM and payload is COMMAND(uppercase) | ||
| + | |- | ||
| + | | nh/li/state/ROOM/ZONE || Lighting State || Retained Topic! ROOM(lowercase) is one of the pre defined rooms ZONE within a ROOM and payload is Curent STATE(uppercase) | ||
| + | |} | ||
| + | Set commands <br /> | ||
* ON | * ON | ||
* OFF | * OFF | ||
* TOGGLE | * TOGGLE | ||
| − | + | State Repplies<br /> | |
* ON | * ON | ||
* OFF | * OFF | ||
| Line 27: | Line 38: | ||
Rooms And zones<br/> | Rooms And zones<br/> | ||
if no zone listed use 1<br/> | if no zone listed use 1<br/> | ||
| + | * all/0 | ||
| + | ** both controllers will respond to this, however hall/1 doesn't not as that will be based on the door contacts | ||
Controller 1<br/> | Controller 1<br/> | ||
* Workshop | * Workshop | ||
| Line 53: | Line 66: | ||
** 1 (walk way) | ** 1 (walk way) | ||
** 2 (seating) | ** 2 (seating) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===LLAP Protocol=== | ===LLAP Protocol=== | ||
MattrixMQTT automatically converts all LLAP messages in the Hackspace to MQTT<br /> | MattrixMQTT automatically converts all LLAP messages in the Hackspace to MQTT<br /> | ||
| − | To keep thing simple | + | To keep thing simple we use the LLAP Button firmware as detailed [http://openmicros.org/index.php/articles/87-llap-lightweight-local-automation-protocol/llap-devices-commands-and-instructions/121-xrf-firmware-button Here]<br /> |
As we are just looking for basic push button we can use TYP0 mode, this sends ayyBUTTONA-- or ayyBUTTONB-- on a debounced button press<br /> | As we are just looking for basic push button we can use TYP0 mode, this sends ayyBUTTONA-- or ayyBUTTONB-- on a debounced button press<br /> | ||
| − | MatrixMQTT needs updating to ACK messages so we don't get 5 at once, or adjust retires to 0. | + | MatrixMQTT needs updating to ACK messages so we don't get 5 at once, or adjust LLAP retires to 0. |
| − | Each XRF can be given its own DEVID, here is a map table of DEVID/button to zone's | + | Each XRF can be given its own two char DEVID, here is a map table of DEVID/button to zone's |
{| class="wikitable" | {| class="wikitable" | ||
| Line 96: | Line 97: | ||
| L4 || B || Box/1 | | L4 || B || Box/1 | ||
|} | |} | ||
| + | |||
| + | |||
| + | ===Controller Firmware=== | ||
| + | Base on the above information the controller firmware for both the studio and workshop was built, this can not be found on [https://github.com/NottingHack/Lighting-Control/ here on GitHub] | ||
| + | |||
| + | Base around the [https://github.com/NottingHack/MQTT-Template MQTT Template] code used for hackspace instrumentation this firmware subscribes to the set topic (nh/li/set/#) and incoming LLAP topic (nh/xrf/rx/#)<br /> | ||
| + | Both topic are wildcard subscription and so on receiving a message the firmware check if it is for a zone under its control, then check the payload to see which command was issued, this is then used to update the shift registers and the new state of the zone is published back to MQTT. | ||
| + | [[Category:Infrastructure]] | ||
| + | [[Category:Lighting]] | ||
Revision as of 16:00, 30 October 2021
Command structure
This is based around posible commands we want to issue.
There is a total of 11 rooms and 17 zones.
The Workshop, Stuido, and Comfy Area have multiple zones.
There will be times when we want to change all zones in these rooms, also time when we might want to act on multiple rooms.
An 'All Off' button for the workshop should include the electronics bench, an 'All off' for the Stuido should include the Comfy Area?
Master all off from the last man switch should be all but the hall
Switch panels should not care about current state and should just send 'toggle' state commands per zone, except for posible all off/on buttons
Special function scripts form holly may want to set certain states, these will not matter about current state but would be setiing a defined on/off.
Control box firmware will be responsible for sending out retained STATE messages after it has switched any zone, 0 (all) zones may/may-not have state,
The two big switch panels are using state to change LED's and any script on Holly can you state's as needed
By using retained state MQTT messages any new client or reconnecting client subscribing to nh/li/sate/# will be feed the state of all current zone's
Internally the control box firmware will have to track state of each zone it's in charge of.
MQTT Commands
Based around the following MQTT topic structure
| Topic | Description | Notes |
|---|---|---|
| nh/li/set/ROOM/ZONE | Lighting Command | ROOM(lowercase) is one of the pre defined rooms ZONE within a ROOM and payload is COMMAND(uppercase) |
| nh/li/state/ROOM/ZONE | Lighting State | Retained Topic! ROOM(lowercase) is one of the pre defined rooms ZONE within a ROOM and payload is Curent STATE(uppercase) |
Set commands
- ON
- OFF
- TOGGLE
State Repplies
- ON
- OFF
Rooms And zones
if no zone listed use 1
- all/0
- both controllers will respond to this, however hall/1 doesn't not as that will be based on the door contacts
Controller 1
- Workshop
- 0 (all)
- 1 (wood working)
- 2 (Cnc's)
- 3 (metal working
- 4 (bike)
- Electronics
- Textiles
- Toilets
Controller 2
- Kitchen
- Blue
- Storage
- Box
- Hall
- Studio
- 0 (all)
- 1 (walk way)
- 2 (middle)
- 3 (far side)
- Comfy
- 0 (all)
- 1 (walk way)
- 2 (seating)
LLAP Protocol
MattrixMQTT automatically converts all LLAP messages in the Hackspace to MQTT
To keep thing simple we use the LLAP Button firmware as detailed Here
As we are just looking for basic push button we can use TYP0 mode, this sends ayyBUTTONA-- or ayyBUTTONB-- on a debounced button press
MatrixMQTT needs updating to ACK messages so we don't get 5 at once, or adjust LLAP retires to 0.
Each XRF can be given its own two char DEVID, here is a map table of DEVID/button to zone's
| DEVID | Button | Room/zone |
|---|---|---|
| L1 | A | Textiles/1 |
| L1 | B | Not used |
| L2 | A | Toilet/1 |
| L2 | B | Kitchen/1 |
| L3 | A | Blue/1 |
| L3 | B | Not Used |
| L4 | A | Storage/1 |
| L4 | B | Box/1 |
Controller Firmware
Base on the above information the controller firmware for both the studio and workshop was built, this can not be found on here on GitHub
Base around the MQTT Template code used for hackspace instrumentation this firmware subscribes to the set topic (nh/li/set/#) and incoming LLAP topic (nh/xrf/rx/#)
Both topic are wildcard subscription and so on receiving a message the firmware check if it is for a zone under its control, then check the payload to see which command was issued, this is then used to update the shift registers and the new state of the zone is published back to MQTT.