data/qmi-service-pds.json

   1
   2 [
   3   // *********************************************************************************
   4   {  "name"    : "PDS",
   5      "type"    : "Service" },
   6
   7   // *********************************************************************************
   8   {  "name"    : "QMI Client PDS",
   9      "type"    : "Client",
  10      "since"   : "1.0" },
  11
  12   // *********************************************************************************
  13   {  "name"    : "QMI Message PDS",
  14      "type"    : "Message-ID-Enum" },
  15
  16   // *********************************************************************************
  17   {  "name"    : "QMI Indication PDS",
  18      "type"    : "Indication-ID-Enum" },
  19
  20   // *********************************************************************************
  21   {  "name"    : "Reset",
  22      "type"    : "Message",
  23      "service" : "PDS",
  24      "id"      : "0x0000",
  25      "since"   : "1.0",
  26      "output"  : [ { "common-ref" : "Operation Result" } ] },
  27
  28   // *********************************************************************************
  29   {  "name"    : "Set Event Report",
  30      "type"    : "Message",
  31      "service" : "PDS",
  32      "id"      : "0x0001",
  33      "since"   : "1.0",
  34      "input"   : [ { "name"          : "NMEA Position Reporting",
  35                      "id"            : "0x10",
  36                      "type"          : "TLV",
  37                      "since"         : "1.0",
  38                      "format"        : "guint8",
  39                      "public-format" : "gboolean" },
  40                    { "name"          : "Extended NMEA Position Reporting",
  41                      "id"            : "0x11",
  42                      "type"          : "TLV",
  43                      "since"         : "1.0",
  44                      "format"        : "guint8",
  45                      "public-format" : "gboolean" },
  46                    { "name"          : "Parsed Position Reporting",
  47                      "id"            : "0x12",
  48                      "type"          : "TLV",
  49                      "since"         : "1.0",
  50                      "format"        : "guint8",
  51                      "public-format" : "gboolean" },
  52                    { "name"          : "External XTRA Data Request Reporting",
  53                      "id"            : "0x13",
  54                      "type"          : "TLV",
  55                      "since"         : "1.0",
  56                      "format"        : "guint8",
  57                      "public-format" : "gboolean" },
  58                    { "name"          : "External Time Injection Request Reporting",
  59                      "id"            : "0x14",
  60                      "type"          : "TLV",
  61                      "since"         : "1.0",
  62                      "format"        : "guint8",
  63                      "public-format" : "gboolean" },
  64                    { "name"          : "External WIFI Position Request Reporting",
  65                      "id"            : "0x15",
  66                      "type"          : "TLV",
  67                      "since"         : "1.0",
  68                      "format"        : "guint8",
  69                      "public-format" : "gboolean" },
  70                    { "name"          : "Satellite Information Reporting",
  71                      "id"            : "0x16",
  72                      "type"          : "TLV",
  73                      "since"         : "1.0",
  74                      "format"        : "guint8",
  75                      "public-format" : "gboolean" },
  76                    { "name"          : "VX Network Initiated Request Reporting",
  77                      "id"            : "0x17",
  78                      "type"          : "TLV",
  79                      "since"         : "1.0",
  80                      "format"        : "guint8",
  81                      "public-format" : "gboolean" },
  82                    { "name"          : "SUPL Network Initiated Prompt Reporting",
  83                      "id"            : "0x18",
  84                      "type"          : "TLV",
  85                      "since"         : "1.0",
  86                      "format"        : "guint8",
  87                      "public-format" : "gboolean" },
  88                    { "name"          : "UMTS CP Network Initiated Prompt Reporting",
  89                      "id"            : "0x19",
  90                      "type"          : "TLV",
  91                      "since"         : "1.0",
  92                      "format"        : "guint8",
  93                      "public-format" : "gboolean" },
  94                    { "name"          : "PDS Comm Event Reporting",
  95                      "id"            : "0x1A",
  96                      "type"          : "TLV",
  97                      "since"         : "1.0",
  98                      "format"        : "guint8",
  99                      "public-format" : "gboolean" },
 100                    { "name"          : "Accelerometer Data Streaming Ready Reporting",
 101                      "id"            : "0x1B",
 102                      "type"          : "TLV",
 103                      "since"         : "1.0",
 104                      "format"        : "guint8",
 105                      "public-format" : "gboolean" },
 106                    { "name"          : "Gyro Data Streaming Ready Reporting",
 107                      "id"            : "0x1C",
 108                      "type"          : "TLV",
 109                      "since"         : "1.0",
 110                      "format"        : "guint8",
 111                      "public-format" : "gboolean" },
 112                    { "name"          : "Time Sync Request Reporting",
 113                      "id"            : "0x1D",
 114                      "type"          : "TLV",
 115                      "since"         : "1.0",
 116                      "format"        : "guint8",
 117                      "public-format" : "gboolean" },
 118                    { "name"          : "Position Reliability Indicator Reporting",
 119                      "id"            : "0x1E",
 120                      "type"          : "TLV",
 121                      "since"         : "1.0",
 122                      "format"        : "guint8",
 123                      "public-format" : "gboolean" },
 124                    { "name"          : "Sensor Data Usage Indicator Reporting",
 125                      "id"            : "0x1F",
 126                      "type"          : "TLV",
 127                      "since"         : "1.0",
 128                      "format"        : "guint8",
 129                      "public-format" : "gboolean" },
 130                    { "name"          : "Time Source Information Reporting",
 131                      "id"            : "0x20",
 132                      "type"          : "TLV",
 133                      "since"         : "1.0",
 134                      "format"        : "guint8",
 135                      "public-format" : "gboolean" },
 136                    { "name"          : "Heading Uncertainty Reporting",
 137                      "id"            : "0x21",
 138                      "type"          : "TLV",
 139                      "since"         : "1.0",
 140                      "format"        : "guint8",
 141                      "public-format" : "gboolean" },
 142                    { "name"          : "NMEA Debug Strings Reporting",
 143                      "id"            : "0x22",
 144                      "type"          : "TLV",
 145                      "since"         : "1.0",
 146                      "format"        : "guint8",
 147                      "public-format" : "gboolean" },
 148                    { "name"          : "Extended External XTRA Data Request Reporting",
 149                      "id"            : "0x23",
 150                      "type"          : "TLV",
 151                      "since"         : "1.0",
 152                      "format"        : "guint8",
 153                      "public-format" : "gboolean" } ],
 154      "output"  : [ { "common-ref" : "Operation Result" } ] },
 155
 156   {  "name"    : "Event Report",
 157      "type"    : "Indication",
 158      "service" : "PDS",
 159      "id"      : "0x0001",
 160      "since"   : "1.0",
 161      "output"  : [ { "name"      : "NMEA Position",
 162                      "id"        : "0x10",
 163                      "type"      : "TLV",
 164                      "since"     : "1.0",
 165                      "format"    : "string",
 166                      "max-size"  : "200" },
 167                    { "name"      : "Extended NMEA Position",
 168                      "id"        : "0x11",
 169                      "type"      : "TLV",
 170                      "since"     : "1.0",
 171                      "format"    : "sequence",
 172                      "contents"  : [ { "name"          : "Operation Mode",
 173                                        "format"        : "gint8",
 174                                        "public-format" : "QmiPdsOperationMode" },
 175                                      { "name"     : "NMEA",
 176                                        "format"   : "string",
 177                                        // This was supposed to be only 1 byte for length, but it seems it's not
 178                                        "size-prefix-format" : "guint16",
 179                                        "max-size" : "200" } ] },
 180                    { "name"          : "Position Session Status",
 181                      "id"            : "0x12",
 182                      "type"          : "TLV",
 183                      "since"         : "1.0",
 184                      "format"        : "guint8",
 185                      "public-format" : "QmiPdsPositionSessionStatus" } ] },
 186
 187                    // TODO: parse all TLVs of this indication
 188                    // Reading gfloat/gdouble is still missing
 189                    //{ "name"         : "Parsed Position",
 190                    //  "id"           : "0x13",
 191                    //  "type"         : "TLV",
 192                    //  "format"       : "sequence",
 193                    //  "contents"     : [ { "name"   : "Valid Mask",
 194                    //                       "format" : "gint8" },
 195                    //                     { "name"     : "Timestamp Calendar",
 196                    //                       "format"   : "struct",
 197                    //                       "contents" : [ { "name"   : "Year",
 198                    //                                        "format" : "guint16" },
 199                    //                                      { "name"   : "Month",
 200                    //                                        "format" : "guint8" },
 201                    //                                      { "name"   : "Day Of Week",
 202                    //                                        "format" : "guint8" },
 203                    //                                      { "name"   : "Day of Month",
 204                    //                                        "format" : "guint8" },
 205                    //                                      { "name"   : "Hour",
 206                    //                                        "format" : "guint8" },
 207                    //                                      { "name"   : "Minute",
 208                    //                                        "format" : "guint8" },
 209                    //                                      { "name"   : "Second",
 210                    //                                        "format" : "guint8" },
 211                    //                                      { "name"   : "Millisecond",
 212                    //                                        "format" : "guint16" } ] },
 213                    //                     { "name"   : "Leap Seconds",
 214                    //                       "format" : "guint8" },
 215                    //                     { "name"   : "Timestamp UTC",
 216                    //                       "format" : "guint64" },
 217                    //                     { "name"   : "Time Uncertainty",
 218                    //                       "format" : "guint32" },
 219                    //                     { "name"   : "Latitude",
 220                    //                       "format" : "gdouble" },
 221                    //                     { "name"   : "Longitude",
 222                    //                       "format" : "gdouble" },
 223                    //                     { "name"   : "Altitude Ellipsoid",
 224                    //                       "format" : "gfloat" },
 225                    //                     { "name"   : "Altitude Sea Level",
 226                    //                       "format" : "gfloat" },
 227                    //                     { "name"   : "Horizontal Speed",
 228                    //                       "format" : "gfloat" },
 229                    //                     { "name"   : "Vertical Speed",
 230                    //                       "format" : "gfloat" },
 231                    //                     { "name"   : "Heading",
 232                    //                       "format" : "gfloat" },
 233                    //                     { "name"   : "Horizontal Uncertainty Circular",
 234                    //                       "format" : "gfloat" },
 235                    //                     { "name"   : "Horizontal Uncertainty Ellipse Semi Major",
 236                    //                       "format" : "gfloat" },
 237                    //                     { "name"   : "Horizontal Uncertainty Ellipse Semi Minor",
 238                    //                       "format" : "gfloat" },
 239                    //                     { "name"   : "Horizontal Uncertainty Ellipse Orient Azimuth",
 240                    //                       "format" : "gfloat" },
 241                    //                     { "name"   : "Vertical Uncertainty",
 242                    //                       "format" : "gfloat" },
 243                    //                     { "name"   : "Horizontal Velocity Uncertainty",
 244                    //                       "format" : "gfloat" },
 245                    //                     { "name"   : "Vertical Velocity Uncertainty",
 246                    //                       "format" : "gfloat" },
 247                    //                     { "name"   : "Horizontal confidence",
 248                    //                       "format" : "guint8" },
 249                    //                     { "name"   : "Position DOP",
 250                    //                       "format" : "gfloat" },
 251                    //                     { "name"   : "Horizontal DOP",
 252                    //                       "format" : "gfloat" },
 253                    //                     { "name"   : "Vertical DOP",
 254                    //                       "format" : "gfloat" },
 255                    //                     { "name"          : "Operation Mode",
 256                    //                       "format"        : "gint8",
 257                    //                       "public-format" : "QmiPdsOperationMode" } ],
 258                    //  "prerequisites": [ { "field"     : "Position Session Status",
 259                    //                       "operation" : "<=",
 260                    //                       "value"     : "QMI_PDS_POSITION_SESSION_STATUS_IN_PROGRESS" } ] } ] }
 261
 262   // *********************************************************************************
 263   {  "name"    : "Get GPS Service State",
 264      "type"    : "Message",
 265      "service" : "PDS",
 266      "id"      : "0x0020",
 267      "since"   : "1.0",
 268      "output"  : [ { "common-ref" : "Operation Result" },
 269                    { "name"      : "State",
 270                      "id"        : "0x01",
 271                      "type"      : "TLV",
 272                      "since"     : "1.0",
 273                      "format"    : "sequence",
 274                      "contents"  : [ { "name"          : "GPS Service State",
 275                                        "format"        : "guint8",
 276                                        "public-format" : "gboolean" },
 277                                      { "name"          : "Tracking Session State",
 278                                        "format"        : "guint8",
 279                                        "public-format" : "QmiPdsTrackingSessionState" } ],
 280                      "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
 281
 282   // *********************************************************************************
 283   {  "name"    : "Set GPS Service State",
 284      "type"    : "Message",
 285      "service" : "PDS",
 286      "id"      : "0x0021",
 287      "since"   : "1.0",
 288      "input"   : [ { "name"      : "State",
 289                      "id"        : "0x01",
 290                      "type"      : "TLV",
 291                      "since"     : "1.0",
 292                      "format"    : "sequence",
 293                      "contents"  : [ { "name"          : "GPS Service State",
 294                                        "format"        : "guint8",
 295                                        "public-format" : "gboolean" } ] } ],
 296      "output"  : [ { "common-ref" : "Operation Result" } ] },
 297
 298   // *********************************************************************************
 299   {  "name"    : "Get Default Tracking Session",
 300      "type"    : "Message",
 301      "service" : "PDS",
 302      "id"      : "0x0029",
 303      "since"   : "1.12",
 304      "output"  : [ { "common-ref" : "Operation Result" },
 305                    { "name"      : "Info",
 306                      "id"        : "0x01",
 307                      "type"      : "TLV",
 308                      "since"     : "1.12",
 309                      "format"    : "sequence",
 310                      "contents"  : [ { "name"          : "Session Operation",
 311                                        "format"        : "guint8",
 312                                        "public-format" : "QmiPdsOperatingMode" },
 313                                      { "name"          : "Position Data Timeout",
 314                                        "format"        : "guint8" },
 315                                      { "name"          : "Interval",
 316                                        "format"        : "guint32" },
 317                                      { "name"          : "Accuracy Threshold",
 318                                        "format"        : "guint32" } ],
 319                      "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
 320
 321   // *********************************************************************************
 322   {  "name"    : "Set Default Tracking Session",
 323      "type"    : "Message",
 324      "service" : "PDS",
 325      "id"      : "0x002A",
 326      "since"   : "1.12",
 327      "input"   : [ { "name"      : "Info",
 328                      "id"        : "0x01",
 329                      "type"      : "TLV",
 330                      "since"     : "1.12",
 331                      "format"    : "sequence",
 332                      "contents"  : [ { "name"          : "Session Operation",
 333                                        "format"        : "guint8",
 334                                        "public-format" : "QmiPdsOperatingMode" },
 335                                      { "name"          : "Position Data Timeout",
 336                                        "format"        : "guint8" },
 337                                      { "name"          : "Interval",
 338                                        "format"        : "guint32" },
 339                                      { "name"          : "Accuracy Threshold",
 340                                        "format"        : "guint32" } ] } ],
 341      "output"  : [ { "common-ref" : "Operation Result" } ] },
 342
 343   // *********************************************************************************
 344   {  "name"    : "Get AGPS Config",
 345      "type"    : "Message",
 346      "service" : "PDS",
 347      "id"      : "0x002E",
 348      "since"   : "1.12",
 349      "input"   : [ { "name"          : "Network Mode",
 350                      "id"            : "0x12",
 351                      "type"          : "TLV",
 352                      "since"         : "1.12",
 353                      "format"        : "guint8",
 354                      "public-format" : "QmiPdsNetworkMode" } ],
 355      "output"  : [ { "common-ref" : "Operation Result" },
 356                    { "name"      : "Location Server Address",
 357                      "id"        : "0x10",
 358                      "type"      : "TLV",
 359                      "since"     : "1.12",
 360                      "format"    : "sequence",
 361                      "contents"  : [ { "name"   : "IP",
 362                                        "format" : "guint32",
 363                                        "endian" : "little" },
 364                                      { "name"   : "Port",
 365                                        "format" : "guint32" } ],
 366                      "prerequisites" : [ { "common-ref" : "Success" } ] },
 367                    { "name"               : "Location Server URL",
 368                      "id"                 : "0x11",
 369                      "type"               : "TLV",
 370                      "since"              : "1.12",
 371                      "format"             : "array",
 372                      "size-prefix-format" : "guint8",
 373                      "array-element"      : { "format" : "guint8" },
 374                      "prerequisites"      : [ { "common-ref" : "Success" } ] } ] },
 375
 376   // *********************************************************************************
 377   {  "name"    : "Set AGPS Config",
 378      "type"    : "Message",
 379      "service" : "PDS",
 380      "id"      : "0x002F",
 381      "since"   : "1.12",
 382      "input"   : [ { "name"      : "Location Server Address",
 383                      "id"        : "0x10",
 384                      "type"      : "TLV",
 385                      "since"     : "1.12",
 386                      "format"    : "sequence",
 387                      "contents"  : [ { "name"   : "IP",
 388                                        "format" : "guint32",
 389                                        "format" : "guint32" },
 390                                      { "name"   : "Port",
 391                                        "format" : "guint32" } ] },
 392                    { "name"               : "Location Server URL",
 393                      "id"                 : "0x11",
 394                      "type"               : "TLV",
 395                      "since"              : "1.12",
 396                      "format"             : "array",
 397                      "size-prefix-format" : "guint8",
 398                      "array-element"      : { "format" : "guint8" } },
 399                    { "name"          : "Network Mode",
 400                      "id"            : "0x14",
 401                      "type"          : "TLV",
 402                      "since"         : "1.12",
 403                      "format"        : "guint8",
 404                      "public-format" : "QmiPdsNetworkMode" } ],
 405      "output"  : [ { "common-ref" : "Operation Result" } ] },
 406
 407   // *********************************************************************************
 408   {  "name"    : "Get Auto Tracking State",
 409      "type"    : "Message",
 410      "service" : "PDS",
 411      "id"      : "0x0030",
 412      "since"   : "1.0",
 413      "output"  : [ { "common-ref" : "Operation Result" },
 414                    { "name"      : "State",
 415                      "id"        : "0x01",
 416                      "type"      : "TLV",
 417                      "since"     : "1.0",
 418                      "format"    : "sequence",
 419                      "contents"  : [ { "name"          : "Auto Tracking State",
 420                                        "format"        : "guint8",
 421                                        "public-format" : "gboolean" } ],
 422                      "prerequisites" : [ { "common-ref" : "Success" } ] } ] },
 423
 424   // *********************************************************************************
 425   {  "name"    : "Set Auto Tracking State",
 426      "type"    : "Message",
 427      "service" : "PDS",
 428      "id"      : "0x0031",
 429      "since"   : "1.0",
 430      "input"   : [ { "name"      : "State",
 431                      "id"        : "0x01",
 432                      "type"      : "TLV",
 433                      "since"     : "1.0",
 434                      "format"    : "sequence",
 435                      "contents"  : [ { "name"          : "Auto Tracking State",
 436                                        "format"        : "guint8",
 437                                        "public-format" : "gboolean" } ] } ],
 438      "output"  : [ { "common-ref" : "Operation Result" } ] },
 439
 440   // *********************************************************************************
 441   {  "name"    : "GPS Ready",
 442      "type"    : "Indication",
 443      "service" : "PDS",
 444      "id"      : "0x0060",
 445      "since"   : "1.14" }
 446
 447 ]