Skip to content

led

ibox.led in the library, ibox led in the CLI.

The Internet Box's LEDs: their brightness and status.

status

status(type: Literal['Status', 'Wireless']) -> str

Get LED Brightness Status

Parameters:

Name Type Description Default
type str

LED type. "Status" for main status LED, "Wireless" for Wi-Fi LED (usally on top of device).

required

Returns:

Name Type Description
str str

response content

set

set(type: Literal['Status', 'Wireless'], brightness: int = 100) -> str

Set LED brightness on device.

Parameters:

Name Type Description Default
type str

LED type. "Status" for main status LED, "Wireless" for Wi-Fi LED (usually on top of device).

required
brightness int

LED brightness level (0-100). Default is 100.

100

Returns:

Name Type Description
str str

response content

nmc_status

nmc_status(type: Literal['Status', 'Wireless']) -> str

Get NMC LED status

Parameters:

Name Type Description Default
type str

LED type. "Status" for main status LED, "Wireless" for Wi-Fi LED.

required

Returns:

Name Type Description
str str

response content

party_time

party_time(mode: Literal['on', 'off'] = 'on', flashes: int = 10, interval: float = 0.3) -> str

Flash the Status and Wireless LEDs alternately for a fun party effect.

Parameters:

Name Type Description Default
mode str

"on" to start flashing, "off" to stop (sets both LEDs to full brightness).

'on'
flashes int

Number of flash cycles when mode is "on". Default is 10.

10
interval float

Time in seconds between brightness changes. Default is 0.3.

0.3

morse_code

morse_code(message: str, led: Literal['Status', 'Wireless'] = 'Status', dot_duration: float = 0.15) -> str

Flash a message in Morse code on the specified LED(s).

Parameters:

Name Type Description Default
message str

The text message to encode and flash.

required
led str

Which LED to flash. "Status" or "Wireless". Default is "Status".

'Status'
dot_duration float

Duration in seconds of a single dot. A dash is 3x this. Default is 0.15.

0.15

Returns:

Name Type Description
str str

The Morse code representation of the message.