Skip to content

GitLab

STA5 SmartLink command guidance · Changes

Page history
Update STA5 SmartLink command guidance authored by Ervin Lan's avatar Ervin Lan
Hide whitespace changes
Inline Side-by-side
Showing with 12 additions and 2 deletions
STA5-SmartLink-command-guidance.md
View page @ a8393108
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
- [Designer](#designer) - [Designer](#designer)
- [Purpose](#purpose) - [Purpose](#purpose)
- [Requirement](#requirement) - [Requirement](#requirement)
- [Flow Chart](#flow-chart) - [Main Flow Chart](#main-flow-chart)
- [APIs](#apis) - [APIs](#apis)
- [SmartLink data format](#smartlink-data-format) - [SmartLink data format](#smartlink-data-format)
- [SmartLink data base structure](#smartlink-data-base-structure) - [SmartLink data base structure](#smartlink-data-base-structure)
...@@ -65,7 +65,7 @@ export ...@@ -65,7 +65,7 @@ export
└── libsocket.so └── libsocket.so
</pre> </pre>
## Flow Chart ## Main Flow Chart
```mermaid ```mermaid
graph TD graph TD
A[START] -->|Multi-thread| B(Socket Accepter thread) A[START] -->|Multi-thread| B(Socket Accepter thread)
...@@ -283,6 +283,7 @@ if (ret < 0) { ...@@ -283,6 +283,7 @@ if (ret < 0) {
### Get device information ### Get device information
- From APPs - Client - From APPs - Client
- To get the device info from SmartLink. Send below message to SmartLink. - To get the device info from SmartLink. Send below message to SmartLink.
- Supported types: E_MAIN_UI, E_PHONE_CONNECTIVITY_AA, E_BT_SRV, E_OTHER_TYPE.
| Data member | Value | | Data member | Value |
| -------------------------- | ---------------------------------------- | | -------------------------- | ---------------------------------------- |
...@@ -303,6 +304,7 @@ if (ret < 0) { ...@@ -303,6 +304,7 @@ if (ret < 0) {
### Return device information ### Return device information
- From SmartLink - Server - From SmartLink - Server
- The device info returned from SmartLink. - The device info returned from SmartLink.
- Supported types: E_MAIN_UI, E_PHONE_CONNECTIVITY_AA, E_BT_SRV, E_OTHER_TYPE.
| Data member | Value | | Data member | Value |
| -------------------------- | --------------------------------------------------------------- | | -------------------------- | --------------------------------------------------------------- |
...@@ -322,6 +324,7 @@ if (ret < 0) { ...@@ -322,6 +324,7 @@ if (ret < 0) {
### Device Phone Link ON ### Device Phone Link ON
- From SmartLink - Server - From SmartLink - Server
- The device Phone Link status is ON. - The device Phone Link status is ON.
- Supported types: E_MAIN_UI.
| Data member | Value | | Data member | Value |
| -------------------------- | ---------------------------------------- | | -------------------------- | ---------------------------------------- |
...@@ -341,6 +344,7 @@ if (ret < 0) { ...@@ -341,6 +344,7 @@ if (ret < 0) {
### Device Phone Link OFF ### Device Phone Link OFF
- From SmartLink - Server - From SmartLink - Server
- The device Phone Link status is OFF. - The device Phone Link status is OFF.
- Supported types: E_MAIN_UI.
| Data member | Value | | Data member | Value |
| -------------------------- | ---------------------------------------- | | -------------------------- | ---------------------------------------- |
...@@ -360,6 +364,7 @@ if (ret < 0) { ...@@ -360,6 +364,7 @@ if (ret < 0) {
### UI Phone Link software button ### UI Phone Link software button
- From UI - Client - From UI - Client
- The Phone Link software button pressed, need to notify SmartLink. - The Phone Link software button pressed, need to notify SmartLink.
- Supported types: E_MAIN_UI.
| Data member | Value | | Data member | Value |
| -------------------------- | ---------------------------------------- | | -------------------------- | ---------------------------------------- |
...@@ -380,6 +385,7 @@ if (ret < 0) { ...@@ -380,6 +385,7 @@ if (ret < 0) {
### iAP2 connected ### iAP2 connected
- From BTSRV - Client - From BTSRV - Client
- When iAP2 connected, need to notify SmartLink. - When iAP2 connected, need to notify SmartLink.
- Supported types: E_BT_SRV.
| Data member | Value | | Data member | Value |
| -------------------------- | ---------------------------------------------------------------- | | -------------------------- | ---------------------------------------------------------------- |
...@@ -401,6 +407,7 @@ if (ret < 0) { ...@@ -401,6 +407,7 @@ if (ret < 0) {
### iAP2 disconnected ### iAP2 disconnected
- From BTSRV - Client - From BTSRV - Client
- When iAP2 disconnected, need to notify SmartLink. - When iAP2 disconnected, need to notify SmartLink.
- Supported types: E_BT_SRV.
| Data member | Value | | Data member | Value |
| -------------------------- | ---------------------------------------------------------------- | | -------------------------- | ---------------------------------------------------------------- |
...@@ -422,6 +429,7 @@ if (ret < 0) { ...@@ -422,6 +429,7 @@ if (ret < 0) {
### Pop a window for Phone Link ### Pop a window for Phone Link
- From SmartLink - Server - From SmartLink - Server
- Call UI to pop a window for user confirm if Phone Link connection is allowed or not. - Call UI to pop a window for user confirm if Phone Link connection is allowed or not.
- Supported types: E_MAIN_UI.
| Data member | Value | | Data member | Value |
| -------------------------- | ----------------------------------------- | | -------------------------- | ----------------------------------------- |
...@@ -441,6 +449,7 @@ if (ret < 0) { ...@@ -441,6 +449,7 @@ if (ret < 0) {
### Pop up window return ### Pop up window return
- From UI - Client - From UI - Client
- To return the result of pop up window to SmartLink. - To return the result of pop up window to SmartLink.
- Supported types: E_MAIN_UI.
| Data member | Value | | Data member | Value |
| ----------- | ------------------------------------------------------------------------- | | ----------- | ------------------------------------------------------------------------- |
...@@ -457,6 +466,7 @@ if (ret < 0) { ...@@ -457,6 +466,7 @@ if (ret < 0) {
### Disconnect BT connection with iPhone ### Disconnect BT connection with iPhone
- From SmartLink - Server - From SmartLink - Server
- Call BTSRV to disconnect BT connection with iPhone. - Call BTSRV to disconnect BT connection with iPhone.
- Supported types: E_BT_SRV.
| Data member | Value | | Data member | Value |
| -------------------------- | ---------------------------------------- | | -------------------------- | ---------------------------------------- |
......