BaseCyclic

class BaseCyclicClient
Canonical

kortex_api.autogen.client_stubs.BaseCyclicClientRpc

__init__(router, namespace=None)

Constructs a BaseCyclicClient with an initialized RouterClient and an optional namespace.

Parameters

  • router (RouterClient) – RouterClient used for the communication

  • namespace (string) – Optional namespace on which to initialize the BaseCyclicClient (defaults to None)

IsAlive(timeoutMs: int = 1000)

Returns True if the Service Server is detected online before timeoutMs is expired, False otherwise.

Parameters

timeoutMs (unsigned int) – The maximum time to wait for an answer from the server

Return type

bool

RefreshFeedback(deviceId = 0, options = RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Obtains feedback from base, actuators, and interface on their status
Parameters

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

Return type

Feedback