Mobile SDK

iOS or Android

API Reference - pims.vehicle.command-horn

Info: Stellantis Mobile SDK is not publicly available.
Tutorial: check-out Remote Command.
SDK Version: v2.3
API Available since: v2.0
API Last update: v2.0
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
  • Subscription: Service activation specific to this API are required (see service activation steps).
Operations:

This API allows to send remote command to the vehicle. Before sending any remote to vehicle, you should subscribe pims.vehicle.signal. Use this set of parameters with pims.vehicle.command to honk the vehicle horn.

Input Parameters Object
Param name Description Type Unit/Values Example Required
action

Name of the remote action to perform, in this case horn.

String

horn

horn true
Output Data Object
No outputted data
Error
No errors
Code Example
1
2
3
4
5
6
7
8
9
pims.set("pims.vehicle.command",
  mapOf( /* parameters */  
    Pair("action", "horn")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
1
2
3
4
5
6
7
8
9
pims.set(api: "pims.vehicle.command",
  parameters: [  
    "action": "horn"
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 
1
2
3
4
5
6
// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": { }
}

false