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 163 additions and 0 deletions
STA5-SmartLink-command-guidance.md
View page @ fab43fe4
...@@ -10,6 +10,16 @@ ...@@ -10,6 +10,16 @@
- [On Top Notification](#on-top-notification) - [On Top Notification](#on-top-notification)
- [On Top Notification for Android Auto](#on-top-notification-for-android-auto) - [On Top Notification for Android Auto](#on-top-notification-for-android-auto)
- [Get Up](#get-up) - [Get Up](#get-up)
- [Get Down](#get-down)
- [Get WiFi status](#get-wifi-status)
- [Return WiFi status](#return-wifi-status)
- [Get device information](#get-device-information)
- [Return device information](#return-device-information)
- [Device Phone Link ON](#device-phone-link-on)
- [Device Phone Link OFF](#device-phone-link-off)
- [VIP Socket](#vip-socket)
- [Android Auto VIP Socket](#android-auto-vip-socket)
- [CarPlay VIP Socket](#carplay-vip-socket)
## Requirement ## Requirement
- Platform: STA5 - Platform: STA5
...@@ -149,3 +159,156 @@ if (ret < 0) { ...@@ -149,3 +159,156 @@ if (ret < 0) {
| cmd | E_GET_UP | | cmd | E_GET_UP |
| len | Total length of message in bytes(288). | | len | Total length of message in bytes(288). |
### Get Down
- From SmartLink - Server
- Notify APP to hide to background.
| Data member | Value |
| ----------- | -------------------------------------- |
| version | SML_MAJOR_VERSION |
| mode | E_DELEGATE |
| AppType | Refer to type APP_TYPE. |
| state | E_STATE_OK |
| AppClientID | Client ID. |
| srcAppName | "SML" |
| dstAppName | Received Application name. |
| cmd | E_GET_DOWN |
| len | Total length of message in bytes(288). |
### Get WiFi status
- From APPs - Client
- To get the Wi-Fi AP status from SmartLink. Send below message to SmartLink.
| Data member | Value |
| ----------- | -------------------------------------- |
| version | SML_MAJOR_VERSION |
| mode | E_DELEGATE |
| AppType | Refer to type APP_TYPE. |
| state | E_STATE_OK |
| AppClientID | Client ID. |
| srcAppName | Source application name in string. |
| dstAppName | "SML" |
| cmd | E_REQ_GET_WIFI_STATUS |
| len | Total length of message in bytes(288). |
- From SmartLink: Returned message, refer next section(Return WiFi status).
### Return WiFi status
- From SmartLink - Server
- Wi-Fi AP status returned from SmartLink:
- E_RETURN_WIFI_STATUS_ON means Wi-Fi AP is on and ready.
- E_RETURN_WIFI_STATUS_OFF means Wi-Fi AP is off and not ready.
| Data member | Value |
| ----------- | ------------------------------------------------ |
| version | SML_MAJOR_VERSION |
| mode | E_DELEGATE |
| AppType | Refer to type APP_TYPE. |
| state | E_STATE_OK |
| AppClientID | Client ID. |
| srcAppName | "SML" |
| dstAppName | Received Application name. |
| cmd | E_RETURN_WIFI_STATUS_ON/E_RETURN_WIFI_STATUS_OFF |
| len | Total length of message in bytes(288). |
### Get device information
- From APPs - Client
- To get the device info from SmartLink. Send below message to SmartLink.
| Data member | Value |
| -------------------------- | ---------------------------------------- |
| version | SML_MAJOR_VERSION |
| mode | E_DELEGATE |
| AppType | Refer to type APP_TYPE. |
| state | E_STATE_OK |
| AppClientID | Client ID. |
| srcAppName | Source application name in string. |
| dstAppName | "SML" |
| cmd | E_REQ_GET_DEVICE_INFO |
| len | Total length of message in bytes(288+6). |
| ---Outside of 288 bytes--- | |
| BtMacAddress[6] | 6 bytes, the BT MAC address of MD. |
- From SmartLink: Returned message, refer next page(Return device information).
### Return device information
- From SmartLink - Server
- The device info returned from SmartLink.
| Data member | Value |
| -------------------------- | --------------------------------------------------------------- |
| version | SML_MAJOR_VERSION |
| mode | E_DELEGATE |
| AppType | Refer to type APP_TYPE. |
| state | E_STATE_OK |
| AppClientID | Client ID. |
| srcAppName | "SML" |
| dstAppName | Received Application name |
| cmd | E_RETURN_DEVICE_INFO |
| len | Total length of message in bytes(288+10). |
| ---Outside of 288 bytes--- | |
| BtMacAddress[6] | 6 bytes, the BT MAC address from E_REQ_GET_DEVICE_INFO command. |
| SupportedAPP | 4 bytes, refer to APP_TYPE. |
### Device Phone Link ON
- From SmartLink - Server
- The device Phone Link status is ON.
| Data member | Value |
| -------------------------- | ---------------------------------------- |
| version | SML_MAJOR_VERSION |
| mode | E_DELEGATE |
| AppType | Refer to type APP_TYPE. |
| state | E_STATE_OK |
| AppClientID | Client ID. |
| srcAppName | "SML" |
| dstAppName | Received Application name |
| cmd | E_DEVICE_PHONE_LINK_ON |
| len | Total length of message in bytes(288+6). |
| ---Outside of 288 bytes--- | |
| BtMacAddress[6] | 6 bytes, the BT MAC address of MD. |
### Device Phone Link OFF
- From SmartLink - Server
- The device Phone Link status is OFF.
| Data member | Value |
| -------------------------- | ---------------------------------------- |
| version | SML_MAJOR_VERSION |
| mode | E_DELEGATE |
| AppType | Refer to type APP_TYPE. |
| state | E_STATE_OK |
| AppClientID | Client ID. |
| srcAppName | "SML" |
| dstAppName | Received Application name |
| cmd | E_DEVICE_PHONE_LINK_OFF |
| len | Total length of message in bytes(288+6). |
| ---Outside of 288 bytes--- | |
| BtMacAddress[6] | 6 bytes, the BT MAC address of MD. |
## VIP Socket
### Android Auto VIP Socket
- Purpose: For Android Auto resource manager data transfer between Android Auto and SmartLink.
- The Data type and Data are defined in header file: aa_rsc_mgr.h.
| Object | Description |
| --------------------------------- | ------------------------------------------------------- |
| Socket Path(defined in sml_def.h) | #define TMP_SOCKET_AA_VIP "/tmp/socket_aa_vip" |
| Message format(From SmartLink) | “Ez”+(Total Length of Message)+(Data type)+(Data)+”RCM” |
- Total length of message: 16 bit.
- Data type: 8 bit.
### CarPlay VIP Socket
- Purpose: For CarPlay resource manager data transfer between CarPlay and SmartLink.
- The ResourceID and Data are defined in header file: cp_rsc_mgr.h.
| Object | Description |
| --------------------------------- | ---------------------------------------------- |
| Socket Path(defined in sml_def.h) | #define TMP_SOCKET_CP_VIP "/tmp/socket_cp_vip" |
| Message format(From SmartLink) | (ResourceID)+(Length of Data)+(Data) |
- ResourceID: 32 bit.
- Length of data: 32 bit.
- Data: Length of data.
\ No newline at end of file