mxcubecore.HardwareObjects.BlissProxy#

BLISS API Client - Access BLISS session and devices via BlissClient

Typical YAML configuration:

class: BlissProxy.BlissProxy
configuration:
  blissapi_url: http://mxcube-test-1:5000

Classes

BlissProxy(name)

Client for the BLISS REST API.
class mxcubecore.HardwareObjects.BlissProxy.BlissProxy(name)[source]#

Bases: HardwareObject

Client for the BLISS REST API.

get_object(name: str) → None[source]#

Return a hardware object by its BLISS name.

Parameters:

name (str) – Beacon address / BLISS object name.

Raises:

KeyError – If name is not registered in the session at all.

Return type:

None

init()[source]#

‘public’ post-initialization method. Override as needed.

For ConfiguredObjects called after loading contained objects.

objects_by_type() → dict[str, list[str]][source]#

Return objects grouped by BLISS type.

Example:

{"Axis": ["dtox", "omega"], "SoftAxis": ["energy"]}
Return type:

dict[str, list[str]]