elkpy.SushiController#
- class elkpy.sushicontroller.SushiController(address='localhost:51051', sushi_proto_def='/usr/share/sushi/sushi_rpc.proto')[source]#
Bases:
objectA class to control sushi via gRPC. This class creates one instance of each different controller type and makes these sub-controllers available as member variables. See the documentation of the separate sub-controllers for their usage.
- Attributes:
_stub (SushiControllerStub): Connection stubs to the gRPC interface implemented in sushi.
- Notes:
close() should ALWAYS be called as part of an application housekeeping/cleanup-before-shutdown routine as it ensure proper releasing of resources and clean joining of concurrent threads.
- close()[source]#
This method should be called at app close. It should call any sub-controller close routines whenever they exist. i.e.: NotificationController has an infinite event loop running in its own thread, which has to be stopped and joined
to ensure clean closing and proper releasing of any resources.
- exception elkpy.sushicontroller.SushiInternalError[source]#
Bases:
ExceptionError thrown if sushi encountered an internal error
- exception elkpy.sushicontroller.SushiInvalidArgumentError[source]#
Bases:
ExceptionError thrown if one or more of the passed arguments are invalid
- exception elkpy.sushicontroller.SushiNotFoundError[source]#
Bases:
ExceptionError thrown if the requested entity is not found in sushi
- exception elkpy.sushicontroller.SushiOutOfRangeError[source]#
Bases:
ExceptionError thrown if one or more of the passed arguments are out of their allowed range
- exception elkpy.sushicontroller.SushiUnkownError[source]#
Bases:
ExceptionError thrown when the source of the error can’t be determined