Skip to content

Library Reference

Representation of an ExoyOne Light.

Source code in src/exoyone/exoyone.py 
 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
class ExoyOne:
    """Representation of an ExoyOne Light."""

    TIMEOUT: ClassVar[float] = 3.0

    def __init__(self, host: str, port: int = 8888) -> None:
        """Initialize the ExoyOne library."""
        self._host = host
        self._port = port
        self._state: ExoyOneState
        self._mp = ModePacks()

    @property
    def host(self) -> str:
        """Return the hostname or IP address used to connect."""
        return self._host

    @property
    def name(self) -> str:
        """Return either the user-defined name or mDNS name."""
        name = self._state.mdnsName
        if len(self._state.userDefinedName) > 0:
            name = self._state.userDefinedName
        return name

    @property
    def state(self) -> ExoyOneState:
        """Returns the in-memory state of the ExoyOne."""
        return self._state

    @property
    def device_type(self) -> str:
        """Return the device type."""
        device_type = ExoyDevices(self._state.type).name
        return device_type.replace("_", " ").title()

    @staticmethod
    def _bool_val(value: bool | int | str) -> int:
        """Return 1 for truthy state or 0 for falsy state."""
        if isinstance(value, int):
            return value

        if isinstance(value, str) and value.upper() in TruthyFalsyWords.__members__:
            return TruthyFalsyWords[value.upper()].value

        raise ExoyOneValueError(f"Invalid value: {value}")

    @backoff.on_exception(
        backoff.expo,
        ExoyOneTimeoutError,
        max_tries=3,
        logger=_LOGGER,
        backoff_log_level=logging.DEBUG,
    )
    async def async_set_data(
        self, request: Mapping[str, Mapping[str, int | str] | bool | int | str]
    ) -> None:
        """Update a setting on the ExoyOne, then get the latest state data."""
        encoded_update = json.dumps(request).encode("utf-8")
        try:
            stream: DatagramClient = await connect((self._host, self._port))
            await asyncio.wait_for(stream.send(encoded_update), timeout=self.TIMEOUT)
        except TimeoutError as exc:
            raise ExoyOneTimeoutError() from exc
        finally:
            stream.close()
            del stream
            await self.async_get_data()

    @backoff.on_exception(
        backoff.expo,
        ExoyOneTimeoutError,
        max_tries=3,
        logger=_LOGGER,
        backoff_log_level=logging.DEBUG,
    )
    async def async_get_data(self) -> None:
        """Update the in-memory state using data from the ExoyOne."""
        try:
            stream: DatagramClient = await connect((self._host, self._port))
            await asyncio.wait_for(stream.send(b'{"getData": 1}'), timeout=self.TIMEOUT)
            reply, _ = await asyncio.wait_for(stream.recv(), timeout=self.TIMEOUT)
            data = json.loads(reply.decode("utf-8"))
            self._state = ExoyOneState(**data)
        except TimeoutError as exc:
            raise ExoyOneTimeoutError() from exc
        finally:
            stream.close()
            del stream

    def get_active_pack_name(self) -> str:
        """Return the name of the currently active modpack."""
        return self._mp.get_pack_name_from_index(self._state.currentModpack)

    def get_active_effect(self) -> str:
        """Return the name of the currently active effect."""
        return self._mp.get_effect_name_from_index(
            pack_index=self._state.currentModpack,
            effect_index=self._state.modeIndex,
        )

    async def async_get_state(self) -> ExoyOneState:
        """Return the current state as an ExoyOne object."""
        await self.async_get_data()
        return self._state

    async def restart_in_ap_mode(self) -> None:
        """Restart the device in AP mode."""
        await self.async_set_data({"restartInApMode": True})

    async def toggle_power(self, state: bool | int | str) -> None:
        """Toggle power."""
        request = {"togglePower": self._bool_val(state)}
        await self.async_set_data(request)

    async def toggle_direction(self, state: bool | int | str) -> None:
        """Toggle direction."""
        request = {"toggleDirection": self._bool_val(state)}
        await self.async_set_data(request)

    async def _async_set_hsbs(self, key: str, value: int) -> None:
        """Helper method to set hue, saturation, brightness and speed."""
        value = max(0, min(value, 255))
        await self.async_set_data({key: value})

    async def set_color(self, hsb: tuple[int, int, int]) -> None:
        """Set the hue, saturation and brightness in a single call."""
        hue = max(0, min(hsb[0], 255))
        saturation = max(0, min(hsb[1], 255))
        brightness = max(0, min(hsb[2], 255))
        await self.async_set_data(
            {
                "setHue": hue,
                "setSaturation": saturation,
                "setBrightness": brightness,
            }
        )

    async def set_hue(self, hue: int) -> None:
        """Set the hue."""
        await self._async_set_hsbs(key="setHue", value=hue)

    async def set_saturation(self, saturation: int) -> None:
        """Set the saturation."""
        await self._async_set_hsbs(key="setSaturation", value=saturation)

    async def set_brightness(self, brightness: int) -> None:
        """Set the brightness."""
        await self._async_set_hsbs(key="setBrightness", value=brightness)

    async def set_speed(self, speed: int) -> None:
        """Set the speed."""
        await self._async_set_hsbs(key="setSpeed", value=speed)

    async def toggle_mode_cycle(self, state: bool | int | str) -> None:
        """Toggle automatic mode change after set interval."""
        request = {"toggleModeCycle": self._bool_val(state)}
        await self.async_set_data(request)

    async def toggle_music_sync(self, state: bool | int | str) -> None:
        """Toggle music sync."""
        request = {"toggleMusicSync": self._bool_val(state)}
        await self.async_set_data(request)

    async def set_cycle_speed(self, cycle_speed: int) -> None:
        """Set cycle speed in seconds."""
        await self.async_set_data({"setCycleSpeed": cycle_speed})

    async def set_effect(self, effect: str | tuple[int, int]) -> None:
        """Set mode mode_pack and effect."""
        if isinstance(effect, str):
            pack_index, effect_index = self._mp.get_indices_from_effect_name(effect)
        else:
            pack_index, effect_index = effect

        if pack_index > -1 and effect_index > -1:
            await self.async_set_data(
                {
                    "setModPack": pack_index,
                    "setEffect": effect_index,
                }
            )

    async def toggle_scene_generation(self, state: bool | int | str) -> None:
        """Toggle scene generation."""
        request = {"toggleSceneGeneration": self._bool_val(state)}
        await self.async_set_data(request)

    async def set_name(self, name: str) -> None:
        """Set a new user-friendly name."""
        if len(name) > 39:
            name = name[:39]
            _LOGGER.warning("Name truncated to maximum allowed length: %s", name[:39])
        await self.async_set_data({"setName": name})

    async def set_shutdown_timer(self, minutes: int) -> None:
        """Set a shutdown timer of at least 5 and at most 480 minutes."""
        if minutes == 0:
            _LOGGER.info("Disabling shutdown timer.")

        elif 1 < minutes < 5:
            _LOGGER.info("Shutdown timer increased to 5 minutes.")
            minutes = 5

        if minutes > 480:
            _LOGGER.info("Shutdown timer reduced to 8 hours.")
            minutes = 480

        hours: int = 0
        if minutes > 60:
            hours = minutes // 60
            minutes = minutes % 60

        await self.async_set_data(
            {"setShutdownTimer": {"hours": hours, "minutes": minutes}}
        )

    async def connect_to_wifi(self, ssid: str, password: str) -> None:
        """Set new Wi-Fi connection credentials."""
        if len(ssid) == 0 or len(password) == 0:
            raise ExoyOneValueError(
                "Both SSID and password must be set to change WiFi credentials"
            )
        if len(ssid) > 31:
            raise ExoyOneValueError(
                "SSID is longer than maximum allowed length of 31 characters"
            )
        if len(password) > 31:
            raise ExoyOneValueError(
                "Password is longer than the maximum allowed length of 31 characters"
            )

        await self.async_set_data(
            {"connectToWifi": {"ssid": ssid, "password": password}}
        )

    async def powered_by_powerbank(self, state: bool | int | str) -> None:
        """Toggle power consumption reduction when running on batteries."""
        request = {"poweredByPowerbank": self._bool_val(state)}
        await self.async_set_data(request)

    async def set_pattern(self, value: int) -> None:
        """Use async_set_data to change the selectedPattern value."""
        await self.async_set_data({"setPattern": value})

    async def set_palette(self, value: int) -> None:
        """Use async_set_data to change the selectedPalette value."""
        await self.async_set_data({"setPalette": value})

    async def set_render_mode(self, value: int) -> None:
        """Use async_set_data to change the selectedRenderMode value."""
        await self.async_set_data({"setRenderMode": value})

    async def set_color_mode(self, value: int) -> None:
        """Use async_set_data to change the selectedColorMode value."""
        await self.async_set_data({"setColorMode": value})

device_type: str property

Return the device type.

host: str property

Return the hostname or IP address used to connect.

name: str property

Return either the user-defined name or mDNS name.

state: ExoyOneState property

Returns the in-memory state of the ExoyOne.

__init__(host, port=8888)

Initialize the ExoyOne library.

Source code in src/exoyone/exoyone.py 
35
36
37
38
39
40
def __init__(self, host: str, port: int = 8888) -> None:
    """Initialize the ExoyOne library."""
    self._host = host
    self._port = port
    self._state: ExoyOneState
    self._mp = ModePacks()

async_get_data() async

Update the in-memory state using data from the ExoyOne.

Source code in src/exoyone/exoyone.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@backoff.on_exception(
    backoff.expo,
    ExoyOneTimeoutError,
    max_tries=3,
    logger=_LOGGER,
    backoff_log_level=logging.DEBUG,
)
async def async_get_data(self) -> None:
    """Update the in-memory state using data from the ExoyOne."""
    try:
        stream: DatagramClient = await connect((self._host, self._port))
        await asyncio.wait_for(stream.send(b'{"getData": 1}'), timeout=self.TIMEOUT)
        reply, _ = await asyncio.wait_for(stream.recv(), timeout=self.TIMEOUT)
        data = json.loads(reply.decode("utf-8"))
        self._state = ExoyOneState(**data)
    except TimeoutError as exc:
        raise ExoyOneTimeoutError() from exc
    finally:
        stream.close()
        del stream

async_get_state() async

Return the current state as an ExoyOne object.

Source code in src/exoyone/exoyone.py 
131
132
133
134
async def async_get_state(self) -> ExoyOneState:
    """Return the current state as an ExoyOne object."""
    await self.async_get_data()
    return self._state

async_set_data(request) async

Update a setting on the ExoyOne, then get the latest state data.

Source code in src/exoyone/exoyone.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@backoff.on_exception(
    backoff.expo,
    ExoyOneTimeoutError,
    max_tries=3,
    logger=_LOGGER,
    backoff_log_level=logging.DEBUG,
)
async def async_set_data(
    self, request: Mapping[str, Mapping[str, int | str] | bool | int | str]
) -> None:
    """Update a setting on the ExoyOne, then get the latest state data."""
    encoded_update = json.dumps(request).encode("utf-8")
    try:
        stream: DatagramClient = await connect((self._host, self._port))
        await asyncio.wait_for(stream.send(encoded_update), timeout=self.TIMEOUT)
    except TimeoutError as exc:
        raise ExoyOneTimeoutError() from exc
    finally:
        stream.close()
        del stream
        await self.async_get_data()

connect_to_wifi(ssid, password) async

Set new Wi-Fi connection credentials.

Source code in src/exoyone/exoyone.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
async def connect_to_wifi(self, ssid: str, password: str) -> None:
    """Set new Wi-Fi connection credentials."""
    if len(ssid) == 0 or len(password) == 0:
        raise ExoyOneValueError(
            "Both SSID and password must be set to change WiFi credentials"
        )
    if len(ssid) > 31:
        raise ExoyOneValueError(
            "SSID is longer than maximum allowed length of 31 characters"
        )
    if len(password) > 31:
        raise ExoyOneValueError(
            "Password is longer than the maximum allowed length of 31 characters"
        )

    await self.async_set_data(
        {"connectToWifi": {"ssid": ssid, "password": password}}
    )

get_active_effect()

Return the name of the currently active effect.

Source code in src/exoyone/exoyone.py 
124
125
126
127
128
129
def get_active_effect(self) -> str:
    """Return the name of the currently active effect."""
    return self._mp.get_effect_name_from_index(
        pack_index=self._state.currentModpack,
        effect_index=self._state.modeIndex,
    )

get_active_pack_name()

Return the name of the currently active modpack.

Source code in src/exoyone/exoyone.py 
120
121
122
def get_active_pack_name(self) -> str:
    """Return the name of the currently active modpack."""
    return self._mp.get_pack_name_from_index(self._state.currentModpack)

powered_by_powerbank(state) async

Toggle power consumption reduction when running on batteries.

Source code in src/exoyone/exoyone.py 
266
267
268
269
async def powered_by_powerbank(self, state: bool | int | str) -> None:
    """Toggle power consumption reduction when running on batteries."""
    request = {"poweredByPowerbank": self._bool_val(state)}
    await self.async_set_data(request)

restart_in_ap_mode() async

Restart the device in AP mode.

Source code in src/exoyone/exoyone.py 
136
137
138
async def restart_in_ap_mode(self) -> None:
    """Restart the device in AP mode."""
    await self.async_set_data({"restartInApMode": True})

set_brightness(brightness) async

Set the brightness.

Source code in src/exoyone/exoyone.py 
176
177
178
async def set_brightness(self, brightness: int) -> None:
    """Set the brightness."""
    await self._async_set_hsbs(key="setBrightness", value=brightness)

set_color(hsb) async

Set the hue, saturation and brightness in a single call.

Source code in src/exoyone/exoyone.py 
155
156
157
158
159
160
161
162
163
164
165
166
async def set_color(self, hsb: tuple[int, int, int]) -> None:
    """Set the hue, saturation and brightness in a single call."""
    hue = max(0, min(hsb[0], 255))
    saturation = max(0, min(hsb[1], 255))
    brightness = max(0, min(hsb[2], 255))
    await self.async_set_data(
        {
            "setHue": hue,
            "setSaturation": saturation,
            "setBrightness": brightness,
        }
    )

set_color_mode(value) async

Use async_set_data to change the selectedColorMode value.

Source code in src/exoyone/exoyone.py 
283
284
285
async def set_color_mode(self, value: int) -> None:
    """Use async_set_data to change the selectedColorMode value."""
    await self.async_set_data({"setColorMode": value})

set_cycle_speed(cycle_speed) async

Set cycle speed in seconds.

Source code in src/exoyone/exoyone.py 
194
195
196
async def set_cycle_speed(self, cycle_speed: int) -> None:
    """Set cycle speed in seconds."""
    await self.async_set_data({"setCycleSpeed": cycle_speed})

set_effect(effect) async

Set mode mode_pack and effect.

Source code in src/exoyone/exoyone.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
async def set_effect(self, effect: str | tuple[int, int]) -> None:
    """Set mode mode_pack and effect."""
    if isinstance(effect, str):
        pack_index, effect_index = self._mp.get_indices_from_effect_name(effect)
    else:
        pack_index, effect_index = effect

    if pack_index > -1 and effect_index > -1:
        await self.async_set_data(
            {
                "setModPack": pack_index,
                "setEffect": effect_index,
            }
        )

set_hue(hue) async

Set the hue.

Source code in src/exoyone/exoyone.py 
168
169
170
async def set_hue(self, hue: int) -> None:
    """Set the hue."""
    await self._async_set_hsbs(key="setHue", value=hue)

set_name(name) async

Set a new user-friendly name.

Source code in src/exoyone/exoyone.py 
218
219
220
221
222
223
async def set_name(self, name: str) -> None:
    """Set a new user-friendly name."""
    if len(name) > 39:
        name = name[:39]
        _LOGGER.warning("Name truncated to maximum allowed length: %s", name[:39])
    await self.async_set_data({"setName": name})

set_palette(value) async

Use async_set_data to change the selectedPalette value.

Source code in src/exoyone/exoyone.py 
275
276
277
async def set_palette(self, value: int) -> None:
    """Use async_set_data to change the selectedPalette value."""
    await self.async_set_data({"setPalette": value})

set_pattern(value) async

Use async_set_data to change the selectedPattern value.

Source code in src/exoyone/exoyone.py 
271
272
273
async def set_pattern(self, value: int) -> None:
    """Use async_set_data to change the selectedPattern value."""
    await self.async_set_data({"setPattern": value})

set_render_mode(value) async

Use async_set_data to change the selectedRenderMode value.

Source code in src/exoyone/exoyone.py 
279
280
281
async def set_render_mode(self, value: int) -> None:
    """Use async_set_data to change the selectedRenderMode value."""
    await self.async_set_data({"setRenderMode": value})

set_saturation(saturation) async

Set the saturation.

Source code in src/exoyone/exoyone.py 
172
173
174
async def set_saturation(self, saturation: int) -> None:
    """Set the saturation."""
    await self._async_set_hsbs(key="setSaturation", value=saturation)

set_shutdown_timer(minutes) async

Set a shutdown timer of at least 5 and at most 480 minutes.

Source code in src/exoyone/exoyone.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
async def set_shutdown_timer(self, minutes: int) -> None:
    """Set a shutdown timer of at least 5 and at most 480 minutes."""
    if minutes == 0:
        _LOGGER.info("Disabling shutdown timer.")

    elif 1 < minutes < 5:
        _LOGGER.info("Shutdown timer increased to 5 minutes.")
        minutes = 5

    if minutes > 480:
        _LOGGER.info("Shutdown timer reduced to 8 hours.")
        minutes = 480

    hours: int = 0
    if minutes > 60:
        hours = minutes // 60
        minutes = minutes % 60

    await self.async_set_data(
        {"setShutdownTimer": {"hours": hours, "minutes": minutes}}
    )

set_speed(speed) async

Set the speed.

Source code in src/exoyone/exoyone.py 
180
181
182
async def set_speed(self, speed: int) -> None:
    """Set the speed."""
    await self._async_set_hsbs(key="setSpeed", value=speed)

toggle_direction(state) async

Toggle direction.

Source code in src/exoyone/exoyone.py 
145
146
147
148
async def toggle_direction(self, state: bool | int | str) -> None:
    """Toggle direction."""
    request = {"toggleDirection": self._bool_val(state)}
    await self.async_set_data(request)

toggle_mode_cycle(state) async

Toggle automatic mode change after set interval.

Source code in src/exoyone/exoyone.py 
184
185
186
187
async def toggle_mode_cycle(self, state: bool | int | str) -> None:
    """Toggle automatic mode change after set interval."""
    request = {"toggleModeCycle": self._bool_val(state)}
    await self.async_set_data(request)

toggle_music_sync(state) async

Toggle music sync.

Source code in src/exoyone/exoyone.py 
189
190
191
192
async def toggle_music_sync(self, state: bool | int | str) -> None:
    """Toggle music sync."""
    request = {"toggleMusicSync": self._bool_val(state)}
    await self.async_set_data(request)

toggle_power(state) async

Toggle power.

Source code in src/exoyone/exoyone.py 
140
141
142
143
async def toggle_power(self, state: bool | int | str) -> None:
    """Toggle power."""
    request = {"togglePower": self._bool_val(state)}
    await self.async_set_data(request)

toggle_scene_generation(state) async

Toggle scene generation.

Source code in src/exoyone/exoyone.py 
213
214
215
216
async def toggle_scene_generation(self, state: bool | int | str) -> None:
    """Toggle scene generation."""
    request = {"toggleSceneGeneration": self._bool_val(state)}
    await self.async_set_data(request)