mirror of
https://github.com/rstrouse/ESPSomfy-RTS.git
synced 2026-10-31 13:52:15 +01:00
fa7aaf0d49
The shade behaviour module (SHADE_BEHAVIOUR_PLAN.md, PR B) reads its settings through read-only structs, so they get one home each: RemoteSettings (flipCommands, bitLength, repeats) under SomfyRemote, shared with groups, and ShadeSettings (types, travel times, step size, flipPosition, simMy, sunSensor) under SomfyShade. Both are base structs, so shade->upTime and group->repeats keep working. A shade's flags byte is split by owner: simMy and sunSensor are settings, light is a field, and the sun flag, sunny, windy, demo mode and lighted bits are stateFlags. getFlags()/setFlags() put the byte together and take it apart for the config file, JSON, MQTT, events and group flags, so nothing saved or sent changes. Groups keep their own flags byte. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
129 lines
6.5 KiB
Markdown
129 lines
6.5 KiB
Markdown
# Glossary
|
|
|
|
Domain terms used in the code, commits and design discussions.
|
|
|
|
## Radio
|
|
|
|
**Radio job**
|
|
One transmission handed to the radio task: an encoded first frame plus a number of repeat frames. A job is either *our own* (a command or sensor frame from one of our remotes, with outcome events) or a *repeater frame* (a frame received from someone else's remote and sent again). A repeater frame reports no events, and since it carries none of our rolling codes it never holds back a stop.
|
|
|
|
**RadioScheduler**
|
|
The module that owns the radio jobs waiting for, or on, the air. It decides their order, when a delayed job is due, which jobs a flush or suspend drops, and the outcome of every job. Producers hand it jobs and get a ticket back. The radio task asks it for the next job and reports back how the job went. It knows nothing about FreeRTOS, the CC1101 or shades.
|
|
|
|
**Ticket**
|
|
What submitting a radio job returns: the job's sequence number, 0 when the radio refused it. Every event about the job carries it. A command that went out over GPIO, not the radio, has ticket 0.
|
|
|
|
**Back job / front job**
|
|
A job normally joins the back of the queue. A *priority* job (a stop) goes to the front, unless an earlier job from the same remote is still waiting. Overtaking that job would put the remote's rolling codes out of order, and the motor would reject the older frame.
|
|
|
|
**Delayed job**
|
|
A job that must wait a given time after it was queued and after the transmission ahead of it ended, so the motor has settled (for example the long press that stores a favorite). It holds up the jobs behind it, but front jobs may overtake it while it waits.
|
|
|
|
**Flush**
|
|
Drops every waiting job (each gets a *dropped* event) and stops the job on air after its current frame (it gets *aborted*).
|
|
|
|
**Suspend**
|
|
Stops the radio taking jobs for a reason (frequency scan, OTA). Suspending flushes; while suspended, new jobs are refused.
|
|
|
|
**Job outcome**
|
|
Every job we submit gets exactly one *started* event, unless it is dropped before going on air. It then ends with exactly one of *finished* (every frame went on air), *aborted* (cut short) or *dropped* (never went on air).
|
|
|
|
**Rolling code**
|
|
The per-remote counter in every Somfy frame. A motor ignores any frame whose code is not newer than the last one it accepted, so a remote's frames must go on air in the order their codes were assigned.
|
|
|
|
**Pulse decoder**
|
|
Turns the times between edges of a received transmission into a frame's bits: it finds the hardware and software sync, which also tell a 56-bit frame from an 80-bit one, then reads the Manchester-coded bits.
|
|
|
|
## Shades
|
|
|
|
**Shade**
|
|
Any motor the firmware drives: a roller, blind, awning, shutter, drapery, garage door, gate or dry contact.
|
|
_Avoid_: blind (one type of shade), cover (Home Assistant's word)
|
|
|
|
**Shade model**
|
|
Everything the user has set up: rooms, shades, groups and repeaters, with their state.
|
|
_Avoid_: installation, config
|
|
|
|
**Favorite**
|
|
The position a motor stores and goes to on My. A shade may have none.
|
|
_Avoid_: My position
|
|
|
|
**Step**
|
|
A short move in one direction, sized by the shade's step time and the number of steps the frame asks for. An integrated tilt turns its slats to the end first, then moves the lift.
|
|
|
|
**Sensor frame**
|
|
A frame from a sun and wind sensor reporting whether it is sunny and whether it is windy. It carries no command; the shade decides what to do.
|
|
|
|
**Sun flag**
|
|
The per-shade switch that lets the sun move a shade. While it is on, lasting sun extends the shade and lasting cloud retracts it; wind retracts the shade whether it is on or not.
|
|
|
|
**Extend / retract**
|
|
Where the weather sends a shade: extend to its favorite, or fully when it has none; retract fully. A tilt-only shade extends and retracts its tilt, every other shade its lift.
|
|
|
|
**ShadeSettings**
|
|
What the user sets up for a shade and its behaviour only reads: shade and tilt type, travel times, step size, flip position, simulated My and sun sensor.
|
|
_Avoid_: config (the whole shade model is saved in the config file)
|
|
|
|
**RemoteSettings**
|
|
What shades and groups share about how their frames go on air: flip commands, bit length and repeats.
|
|
|
|
**Flags**
|
|
The byte a shade is saved and sent with. Its sun sensor, light and simulated My bits are settings; its sun flag, sunny, windy and demo mode bits are state. A group's flags are its shades' flags together.
|
|
|
|
## Entry points and outputs
|
|
|
|
**Entry point**
|
|
Where a request from outside reaches the firmware: an HTTP route, an MQTT command topic or a frame received from a remote.
|
|
_Avoid_: controller (it already names the owner of the shade list and the `/controller` read)
|
|
|
|
**WebUiRoutes**
|
|
The HTTP routes on port 80 that the config web UI calls, plus the UI's own files.
|
|
_Avoid_: WebUiController, Web
|
|
|
|
**ApiRoutes**
|
|
The HTTP routes on port 8081 that integrations such as Home Assistant call.
|
|
_Avoid_: WebApiController
|
|
|
|
**MqttCommands**
|
|
The MQTT topics ending in `/set` that command a shade or group.
|
|
_Avoid_: MQTTController
|
|
|
|
**MqttPublisher**
|
|
What sends the state of rooms, shades and groups, and the Home Assistant discovery config, to the MQTT broker.
|
|
_Avoid_: MQTTController
|
|
|
|
**SocketEmitter**
|
|
What pushes state events to WebSocket clients on port 8080. A client can only join or leave a room; it sends no commands.
|
|
_Avoid_: WebSocketController
|
|
|
|
**MqttConnection**
|
|
The link to the MQTT broker that MqttCommands and MqttPublisher share: connecting, the root topic and the subscriptions.
|
|
_Avoid_: MQTTClass
|
|
|
|
**Change fan-out**
|
|
What sends everything that changed about a shade or group in one pass of `loop()` once: its changed MQTT topics, then one state event.
|
|
|
|
## Domain modules
|
|
|
|
**Domain module**
|
|
A module that holds the rules of one part of the domain, such as what a shade request does. Entry points call it; it never calls an output itself.
|
|
_Avoid_: service, business service
|
|
|
|
**Shade request**
|
|
A request from outside to command a shade or group, set or clear its favorite, unpair it, or correct its position or rolling code. It names the shade or group and gives positions as the client sees them.
|
|
_Avoid_: web command
|
|
|
|
**ShadeRequests**
|
|
The domain module that carries out shade requests, whichever entry point they came from.
|
|
|
|
**ModelEditor**
|
|
The domain module that adds, changes, deletes, links and orders the rooms, shades, groups and repeaters of the shade model.
|
|
_Avoid_: ShadeConfig, InstallationEditor
|
|
|
|
**ModelSnapshot**
|
|
A copy of the shade model taken for one read, so the reply describes a single moment.
|
|
_Avoid_: InstallationSnapshot
|
|
|
|
**LoopQueue**
|
|
The single queue through which shade requests, model edits and snapshot requests reach `loop()` from other tasks, in the order they arrived.
|
|
_Avoid_: web command queue
|