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