Mobile SDK

iOS or Android

    API Reference - pims.vehicle.signal

    Info: Stellantis Mobile SDK for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is not publicly available for now.
    Available since: v2.0.X
    Component: LongRangeRemote
    Security: Authentication is required.
    Prerequisites: Activation Steps being performed.
    Operation:

    This api allows to be notified when receiving vehicle data after a pims.vehicle.command: Charge, ChargeDeferredTime, Doors, Horn, Preconditionning, Warning.

    Input Parameter
    No params
    Output Data
    Data name Description Type Unit/Values Example
    transactionId

    The commandId of your get or set.

    String

    n/a

    Error
    Error Code Error Label
    2325

    Immediate charging request discarded, defered hour has been change

    2326

    Defered hour request discarded, immediate charging has been launch

    2329

    Immediate [ACTION] request discarded due to SEV different than STOP.

    2330

    Immediate charging request discarded due to charging system is standby

    2331

    Immediate charging request discarded due to charging already ongoing.

    2332

    Immediate charging request discarded due to communication problem with charging system.

    2333

    Immediate preconditioning request discarded due to preconditioning already ongoing.

    2334

    Immediate preconditioning request discarded due to communication problem with preconditioning system.

    2335

    Stop preconditioning request discarded due to SEV different than STOP.

    2336

    Stop preconditioning request discarded due to precondtioning not running.

    2337

    Charging Defered Hours need to be update

    2338

    Preconditioning program need to be update

    2339

    Service already started

    2358

    Horn request have been execute with succes earlier wait to send new one

    2359

    Light request have been execute with succes earlier wait to send new one

    2360

    All vehicle’s doors are unlocked

    2361

    All vehicle’s doors are locked

    2362

    Lock/Unlock request discarded due to door open

    Code Example
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    
    /* Subscribe, see unsubscribe below */
    pims.subscribe("pims.vehicle.signal"
      /* no params */
    ) { message -> when (message["status"] as? String) {
          "SUCCEEDED" -> { }                          // handle succeeded status
          "FAILED" ->    { }                          // handle failed status
          "RESULT" ->    {
            if(message["error"] != null) { }            // handle error event code
            else { }                                 // handle result event code
          }
      } }
    
    /* Unsubscribe */
    pims.unsubscribe( "pims.vehicle.signal" /* no params */ )
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    
    /* Subscribe, see unsubscribe below */
    pims.subscribe(api: "pims.vehicle.signal"
      /* no params */
      ) { (message) in 
        if message["status"] == "SUCEEDED"    { }    // handle succeeded status
        else if message["status"] == "FAILED" { }    // handle failed status
        else if status == "RESULT" {
          if !message["error"].isEmpty { }            // handle error event code
          else { }                                    // handle result event code
        }
      } 
    
    /* Unsubscribe */
    pims.unsubscribe( api: "pims.vehicle.signal" /* no params */ )
    
    1
    2
    3
    4
    5
    6
    
    // representation of the `succeeded` dictionary object message as JSON
    {
      "transactionId": "953cfefb-bc72",
      "status": "SUCCEEDED",
      "result": null
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    
    // representation of the `result` dictionary object message as JSON
    {
      "transactionId": "953cfefb-bc72",
      "status": "RESULT",
      "result": {
        "code": 200,
        "resources": {
          "status": {
            "autonomy":145.0,
            "lastUpdate":"2022-02-14T13':'41':58Z",
            "fuelInformation": {
              "autonomy":145.0,
              "chargingInformation": {
                "chargingMode":null,
                "chargingRate":0.0,
                "isPlugged":false,
                "chargingState":null,
                "remainingTime":"PT0S"
              },
              "chargingLevel":42.0,
              "lastUpdate":"2022-02-14T13':'41':57Z",
              "consumption":0.0,
              "type":"fuel"
            },
            "doorStateInformation": {
              "isRearRightDoorOpened":false,
              "isTrunkDoorOpened":false,
              "isLocked":true,
              "isRearWindowDoorOpened":false,
              "isPassengerDoorOpened":false,
              "isRearLeftDoorOpened":false,
              "state": [
                "trunkLocked",
                "locked"
              ],
              "isDriverDoorOpened":false
            },
            "precondInformation": {
              "lastUpdate":"2022-02-14T13':'41':57Z",
              "precondScheduling": [
                {
                  "hour":1,
                  "isEnabled":false,
                  "occurrence": [
                    "mon"
                  ],
                  "slot":1,
                  "minute":48
                }
              ],
              "status":"disabled"
            },
            "electricInformation": {
              "autonomy":0.0,
              "chargingInformation": {
                "chargingMode":"no",
                "chargingRate":0.0,
                "isPlugged":false,
                "nextDeferredChargingDate":"2022-02-14T18':'00':10.715Z",
                "chargingState":"disconnected",
                "remainingTime":"PT0S"
              },
              "chargingLevel":1.0,
              "lastUpdate":"2022-02-14T13':'41':57Z",
              "consumption":0.0,
              "type":"electric"
            },
            "vehicleType":"hybrid"
          }
        },
        "attributes": {
          "engine":"phev",
          "vin":"VR3ATTENTKY102274",
          "brand":"peugeot"
        }
      }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    
    // representation of the `failed` dictionary objects messages as JSON
    
    /* -------- STATUS FAILED: 2325 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2325,
        "label": "Immediate charging request discarded, defered hour has been change"
      }
    }
    /* -------- STATUS FAILED: 2326 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2326,
        "label": "Defered hour request discarded, immediate charging has been launch"
      }
    }
    /* -------- STATUS FAILED: 2329 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2329,
        "label": "Immediate [ACTION] request discarded due to SEV different than STOP."
      }
    }
    /* -------- STATUS FAILED: 2330 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2330,
        "label": "Immediate charging request discarded due to charging system is standby"
      }
    }
    /* -------- STATUS FAILED: 2331 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2331,
        "label": "Immediate charging request discarded due to charging already ongoing."
      }
    }
    /* -------- STATUS FAILED: 2332 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2332,
        "label": "Immediate charging request discarded due to communication problem with charging system."
      }
    }
    /* -------- STATUS FAILED: 2333 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2333,
        "label": "Immediate preconditioning request discarded due to preconditioning already ongoing."
      }
    }
    /* -------- STATUS FAILED: 2334 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2334,
        "label": "Immediate preconditioning request discarded due to communication problem with preconditioning system."
      }
    }
    /* -------- STATUS FAILED: 2335 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2335,
        "label": "Stop preconditioning request discarded due to SEV different than STOP. "
      }
    }
    /* -------- STATUS FAILED: 2336 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2336,
        "label": "Stop preconditioning request discarded due to precondtioning not running."
      }
    }
    /* -------- STATUS FAILED: 2337 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2337,
        "label": "Charging Defered Hours need to be update"
      }
    }
    /* -------- STATUS FAILED: 2338 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2338,
        "label": "Preconditioning program need to be update"
      }
    }
    /* -------- STATUS FAILED: 2339 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2339,
        "label": "Service already started"
      }
    }
    /* -------- STATUS FAILED: 2358 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2358,
        "label": "Horn request have been execute with succes earlier wait to send new one"
      }
    }
    /* -------- STATUS FAILED: 2359 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2359,
        "label": "Light request have been execute with succes earlier wait to send new one"
      }
    }
    /* -------- STATUS FAILED: 2360 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2360,
        "label": "All vehicle's doors are unlocked"
      }
    }
    /* -------- STATUS FAILED: 2361 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2361,
        "label": "All vehicle's doors are locked"
      }
    }
    /* -------- STATUS FAILED: 2362 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2362,
        "label": "Lock/Unlock request discarded due to door open"
      }
    }