API

PLC

class lvmecp.lights.LightsController(name, plc, modbus=None, interval=None, start=True, notifier=None)

Bases: PLCModule

Controller for the light settings.

Parameters:

• name (str)

• plc (PLC)

• modbus (Modbus | None)

• interval (float | None)

• start (bool)

• notifier (Callable[[int, str, dict], Callable | Coroutine] | None)

flag

alias of LightStatus

get_code(light)

Returns the short-form code for a light. Case-insensitive.

Parameters:

light (str) – The light for which the code is seeked.

Examples

>>> get_code('telescope_red')
'tr'
>>> get_code('telescope bright')
'tb'
>>> get_code('uMa Room')
'uma'

Raises:

ValueError – When a code cannot be found for the input light.

Parameters:

light (str)

get_flag(light)

Gets the LightStatus flag associated with a light.

Parameters:

light (str) – The light for which the LightStatus a flag is requested. It can be specified in short form (e.g., tr), using underscores (telescope_red), or spaces (telescope red). The light name is case-insensitive.

async off(light)

Turns off a light.

Parameters:

light (str)

async on(light)

Turns on a light.

Parameters:

light (str)

async toggle(light)

Switches a light.

Parameters:

light (str)

interval: float | None = 30.0

class lvmecp.dome.DomeController(*args, **kwargs)

Bases: PLCModule[DomeStatus]

Controller for the rolling dome.

flag

alias of DomeStatus

async allowed_to_open()

Returns whether the dome is allowed to move.

async close(force=False, mode='normal')

Close the dome.

Parameters:

• force (bool)

• mode (Literal['normal', 'overcurrent'])

is_daytime()

Returns whether it is daytime.

async open(force=False)

Open the dome.

Parameters:

force (bool)

async reset()

Resets the roll-off error state.

async set_direction(open)

Sets the motor direction (True means open, False close).

Parameters:

open (bool)

async stop()

Stops the dome.

interval: float | None = 15.0