Changes between Version 3 and Version 4 of Burt-Research/SystemOverview

Timestamp:

Jan 17, 2018, 9:13:29 PM (6 years ago)

Author:

al

Comment:

--

Burt-Research/SystemOverview

@@ -14 +14 @@
 CoAP communicates based on Representational State Transfer (REST) architecture and supports four modes of REST which are PUT, GET, POST, and DELETE. A client sends a request with any one of the four modes and the server will respond with a reply in accordance with the request. The CoAP supports two modes: reliable and non-reliable. For instance, we use the reliable mode for activating the robot and non-reliable mode for sending force data. Reliability in CoAP is handled by using Confirmable (CON) messages. For every CON message send to the server, this will be replied by Acknowledge (ACK) packages to the client. In essence, CoAP's job is to define the URI structure (a hierarchy of objects accessible by GET/POST); handle GET/POST requests; handle the ACKs for confirmable transmissions; deal with dropped, reordered, or duplicate packets. MessagePack's job is to encode/decode structured data without resorting to encoding numbers as text.
 
+== BurtSharp Message Types ==
+
+The mainboard control loop runs at 500 Hz, able to do math, send and receive messages in a stable and reliable way. BurtSharp subscribes to mainboard control loop messages. The BurtSharp-CoAP client runs in a separate thread “RunControlCycle()” and executes a callback to form the next control cycle output every time a message is received from the server “OnReceiveServerUpdate()”. This is higher reliable than having the replies be completely asynchronous from the mainboard control loop messages. BurtSharp sends one message (“RobotCommand”) per control cycle. 
+
+* The BurtSharp-CoAP client subscribes to observable resource group packages such as:
+  * ServerUpdate
+    * "position": [x, y, z]
+    * "velocity": [x, y, z]
+    * "joint_position": [j1, j2, j3]
+    * "joint_velocities": [j1, j2, j3]
+    * "timestamp": <u32> 
+  * RobotStatus 
+    * "handedness": u8
+    * "Outerlink": u8
+    * "Patient": u8
+    * "Estop": u8
+
+* The BurtSharp-CoAP client sends asynchronous NON-confirmable PUT requests to the mainboard-server through the “AsyncNonPutRequest” method. These requested messages can be one of the following control modes: 
+  * Cartesian Forces
+  * Joint Torques 
+  * Cartesian Torques 
+  * Cartesian Forces + Joints Torques
+
+* The BurtSharp-CoAP client subscribes at mainboard fault updates and to observable resource faults information such as:
+  * MainBoardFault.NotReady
+  * MainBoardFault.NoCanAtStartup
+  * MainBoardFault.NoCoapAtStartup
+  * MainBoardFault.OuterLinkDisconnected
+  * MainBoardFault.HandednessUnknown
+  * MainBoardFault.InvalidEepromCrc
+  * MainBoardFault.EStopPressed
+  * MainBoardFault.EStopLatched
+  * MainBoardFault.InitFailed
+  * MainBoardFault.TorqueLimitJ1
+  * MainBoardFault.TorqueLimitJ2
+  * MainBoardFault.TorqueLimitJ3
+  * MainBoardFault.NotInHomingPositionAtStartup
+
+