Overview
The BLE API enables the robot to communicate with the LOP and COP via BLE requests in order for the robot to take the lift to its desired floor. Currently, the connection timeout duration between the robot and the LOP/COP is set to 90 seconds.
Codes
This section lists all the BLE API codes for the LOP and COP.
LOP
The LOP is responsible for processing the robot's request to call a lift in the direction of its target floor (up or down).
Request Codes
| Code | Purpose |
|---|---|
| AUTH | Authenticate the robot with the LOP |
| DOWN | Press the down button to the LOP |
| UP | Press the up button on the LOP |
| KEEP_ALIVE | Extend the connection timeout duration |
Response Codes
| Code | Purpose |
|---|---|
| AUTH_OK | Robot authentication successful. |
| ERROR | An error has occurred. Please see error message. |
| INFO | Information about the state of the lift. |
| ARRIVAL_UP | Lift travelling up has arrived. |
| ARRIVAL_DOWN | LIft travelling down has arrived |
COP
The COP is responsible for processing the robot's request to go to a particular floor as well as opening and closing the door for the robot to exit and enter.
Request Codes
| Code | Purpose |
|---|---|
| AUTH | Authenticate the robot with the COP |
| CLOSE_DOOR | Closes the lift door |
| OPEN_DOOR | Opens the lift door for a pre-determined duration |
| GO | Go to target floor |
| KEEP_ALIVE | Extends the connection timeout duration |
Response Codes
| Code | Purpose |
|---|---|
| AUTH_OK | Robot authentication successful. |
| ERROR | An error has occurred. Please see error message. |
| INFO | Information about the state of the lift. |
| CURRENT_FLOOR | The COP will continously inform the robot of the current floor of the lift |