ariel-tcu 0.17.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,43 @@
1
+ BaseClass:
2
+ egse.ariel.tcu.TcuInterface
3
+
4
+ ProxyClass:
5
+ egse.ariel.tcu.TcuProxy
6
+
7
+ ControlServerClass:
8
+ egse.ariel.tcu.TcuControlServer
9
+
10
+ ControlServer:
11
+ egse.ariel.tcu.tcu_cs
12
+
13
+ UserInterface:
14
+ egse.ariel.tcu.tcu_ui
15
+
16
+ Commands:
17
+
18
+ # Definition of the DeviceInterface
19
+
20
+ is_simulator:
21
+ description: Ask if the connected class is a simulator instead of the real device Controller class.
22
+ returns: bool | True if the far end is a simulator instead of the real hardware
23
+
24
+ is_connected:
25
+ description: Check if the Hexapod hardware controller is connected.
26
+
27
+ connect:
28
+ description: Connect the Hexapod hardware controller
29
+
30
+ reconnect:
31
+ description: Reconnect the Hexapod hardware controller.
32
+
33
+ This command will force a disconnect and then try to re-connect to the controller.
34
+
35
+ disconnect:
36
+ description: Disconnect from the TCU controller.
37
+
38
+ This command will be send to the TCU Control Server which will then
39
+ disconnect from the hardware controller.
40
+
41
+ This command does not affect the ZeroMQ connection of the Proxy to the
42
+ control server. Use the service command `disconnect_cs()` to disconnect
43
+ from the control server.