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>
50 lines
2.1 KiB
C
50 lines
2.1 KiB
C
#ifndef SHADE_SETTINGS_H
|
|
#define SHADE_SETTINGS_H
|
|
#include <Arduino.h>
|
|
#include "ShadeTypes.h"
|
|
|
|
// The settings a shade's behaviour reads and never changes. The user sets
|
|
// them through JSON, the config file and ModelEditor. Kept free of the shade
|
|
// model so they can be used in the unit tests on the PC (pio test -e native).
|
|
|
|
// What shades and groups share: how their frames go on air.
|
|
struct RemoteSettings {
|
|
bool flipCommands = false;
|
|
uint8_t bitLength = 0;
|
|
uint8_t repeats = 1;
|
|
};
|
|
// What only a shade has.
|
|
struct ShadeSettings {
|
|
shade_types shadeType = shade_types::roller;
|
|
tilt_types tiltType = tilt_types::none;
|
|
uint32_t upTime = 10000;
|
|
uint32_t downTime = 10000;
|
|
uint32_t tiltTime = 7000;
|
|
uint16_t stepSize = 100;
|
|
bool flipPosition = false;
|
|
// Reaches the favorite by moving to it rather than sending My.
|
|
bool simMy = false;
|
|
bool sunSensor = false;
|
|
};
|
|
|
|
// The bits of a shade's flags byte that are settings. The rest are state the
|
|
// shade changes (sun flag, sunny, windy, demo mode) or unused (lighted).
|
|
static const uint8_t SHADE_SETTING_FLAGS = static_cast<uint8_t>(somfy_flags_t::SunSensor) |
|
|
static_cast<uint8_t>(somfy_flags_t::Light) | static_cast<uint8_t>(somfy_flags_t::SimMy);
|
|
|
|
// The flags byte as it is saved and sent, put together from where its bits live.
|
|
inline uint8_t joinShadeFlags(const ShadeSettings &settings, bool light, uint8_t stateFlags) {
|
|
uint8_t flags = stateFlags & ~SHADE_SETTING_FLAGS;
|
|
if(settings.sunSensor) flags |= static_cast<uint8_t>(somfy_flags_t::SunSensor);
|
|
if(light) flags |= static_cast<uint8_t>(somfy_flags_t::Light);
|
|
if(settings.simMy) flags |= static_cast<uint8_t>(somfy_flags_t::SimMy);
|
|
return flags;
|
|
}
|
|
// Splits a saved or sent flags byte back to where its bits live.
|
|
inline void splitShadeFlags(uint8_t flags, ShadeSettings &settings, bool &light, uint8_t &stateFlags) {
|
|
settings.sunSensor = flags & static_cast<uint8_t>(somfy_flags_t::SunSensor);
|
|
light = flags & static_cast<uint8_t>(somfy_flags_t::Light);
|
|
settings.simMy = flags & static_cast<uint8_t>(somfy_flags_t::SimMy);
|
|
stateFlags = flags & ~SHADE_SETTING_FLAGS;
|
|
}
|
|
#endif
|