openflexure_microscope_server.things.system.OpenFlexureSystem

class documentation

class OpenFlexureSystem(lt.Thing): (source)

View In Hierarchy

Describe and control the OpenFlexure system.

This Thing:

  • Exposes information about the Microscope, Server, and Thing states to the web
    API.
  • Controls the underlying OS on the Raspberry Pi allowing shutdown and restarting
    of the system.
Method get_things_state Metadata summarising the current state of all Things in the server.
Method microscope_id A unique identifier for this microscope.
Method microscope_id.setter Undocumented
Method reboot Attempt to reboot the device.
Method shutdown Attempt to shutdown the device.
Property hostname The hostname of the microscope, as reported by its operating system.
Property is_raspberrypi Return True if running on a Raspberry Pi.
Property thing_state Summary metadata describing the current state of the Thing.
Property version_data The version string and version source for the server.
Class Variable _version_data Undocumented
Instance Variable _microscope_id Undocumented
@lt.thing_action
def get_things_state(self, metadata_getter: lt.deps.GetThingStates) -> Mapping: (source)

Metadata summarising the current state of all Things in the server.

@lt.thing_setting
def microscope_id(self) -> UUID: (source)

A unique identifier for this microscope.

def microscope_id(self, uuid: UUID): (source)

Undocumented

@lt.thing_action
def reboot(self) -> CommandOutput: (source)

Attempt to reboot the device.

@lt.thing_action
def shutdown(self) -> CommandOutput: (source)

Attempt to shutdown the device.

@lt.thing_property
hostname: str = (source)

The hostname of the microscope, as reported by its operating system.

@lt.thing_property
is_raspberrypi: bool = (source)

Return True if running on a Raspberry Pi.

@property
thing_state: Mapping = (source)

Summary metadata describing the current state of the Thing.

@lt.thing_property
version_data: VersionData = (source)

The version string and version source for the server.

The source may be a commit hash if installed from git. "TOML" if installed from source, or "Dist" if installed from a distribution package.

If the version or its source cannot be determined an error will be Logged.

_version_data: VersionData | None = (source)

Undocumented

_microscope_id: str | None = (source)

Undocumented