module.locate
The module.locate command is used to locate a module. This command requires that the device be online and connected to the Platform for the request to be processed. This command uses AT commands specific to Telit modules to perform a network based location query, thus only devices with Telit modules will be able to be located. The module can be identified by thingKey, ESN, ICCID, IMEI, IMSI, MEID, or MSISDN. Only one of these identifying fields is required.
TR50 Request
{
"cmd": {
"command": "module.locate",
"params": {
"thingKey": "my_module",
"mode": "tr50"
}
}
}
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
thingKey | String | Yes* | Key of the thing |
thingId | String | Id of the thing | |
esn | String | Esn of the thing | |
iccid | String | Iccid of the thing | |
imei | String | Imei of the thing | |
imsi | String | Imsi of the thing | |
meid | String | Meid of the thing | |
msisdn | String | Msisdn of the thing | |
*One of the above Thing Identifier parameter is required. | |||
mode | String | The mode to send the command ('tr50' or 'sms'). Default is 'auto'. |
TR50 Response
If the command is sent successfully a success message and params list are returned. Otherwise, an error and error message will be returned.
{
"cmd": {
"success": true,
"params": {
"lat": 26.42305,
"lng": -80.12202,
"fixAcc": 10525,
"fixType": "Coarse",
"address": {
"streetNumber": "",
"street": "Military Trl",
"city": "Boca Raton",
"state": "FL",
"zipCode": "33496",
"country": "US"
}
}
}
}
Response Parameters
Name | Type | Description |
---|---|---|
lat | Float | The latitude of the module's location. |
lng | Float | The longitude of the module's location. |
fixAcc | Float | The accuracy in meters of the module's location. |
fixType | String | A string describing the location fixation type. Typically "coarse", "gps", "gnss", "manual", or "m2m-locate". |
address.streetNumber | String | The street number of the module's location. |
address.street | String | The street of the module's location. |
address.city | String | The city of the module's location. |
address.state | String | The state of the module's location. |
address.zipCode | String | The zip code of the module's location. |
address.country | String | The country of the module's location. |