Update SIGNALS.md

This commit is contained in:
Ghassan Yusuf 2020-05-25 13:51:57 +03:00 committed by GitHub
parent 2b6c2c59a9
commit 3c3f3a4657
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -16,24 +16,28 @@ in order to connect to kicker, you need to enable ***Bluetooth*** connection. an
Here we will discuss all sorts of fixed commands, messages, responses - what do they do and what do they mean, and how to use them in our firmware. Ghassan Yusuf built this protocol carefully for high accuracy data arbitration.
#### Game Selection Indicators
When the user selects a game and the data is being sent to the kicker, the kicker responses back with a message to indicate the game type selected
When the user selects a game and the data is being sent to the kicker, the kicker confirms the selection and responses back with a message to indicate the game type selected.
*When counter game is selected*
```
{"gm":"COUNTER"}
```
*When time attack game is selected*
```
{"gm":"TIME ATTACK"}
```
*When reaction game is selected*
```
{"gm":"REACTION"}
```
*When decision game is selected*
```
{"gm":"DECISION"}
```
*When stamina game is selected*
```
{"gm":"STAMINA"}
@ -57,19 +61,12 @@ These messages are for notifying the mobile device with the status of the events
{"status":"ERROR JSON"}
```
```
{"status":"TARGET MEET"}
```
*When the user playes a game and the game ends because the user didnt cach up with the limits he set or the user send a quit command {"cm":"STOP"}, Then it send the following command - it means you quit the game or you could not keep up with the game and ended in loss*
```
{"status":"GAME OVER"}
```
```
{"status":"TIME OVER"}
```
*When the user sends a JSON formated signal in game selection routine, if the signal was not recognized or not understood by the firmware it send back the following response*
```
{"status":"UNKNOWN GAME"}
```
@ -88,10 +85,6 @@ These messages are for notifying the mobile device with the status of the events
{"cm":"STOP"}
```
```
{"cm":"EXIT"}
```
<HR>
## Games Selection
@ -123,7 +116,7 @@ st : Time Of The Kick In Milliseconds
#### Result Calculations
```
number of kicks = (maxct) = kicks
number of kicks = maximum number of kicks the user made on the target
```
<HR>