module.atfota.exec
The module.atfota.exec command is used to execute an ATFOTA operation on a device. The module is identified by either thingKey or thingId.
TR50 Request
{
"cmd": {
"command": "module.atfota.exec",
"params": {
"thingKey": "myThingKey",
"apn": "apn1.carrier.com",
"ftpServer": "http://127.0.0.1/",
"ftpUser": "the_ftp_username",
"ftpPassword": "TheFtpPassWord",
"filePath": "/the/path/to/the/file/",
"fileName": "the_file_name.dat",
"postUpdateDelay": 300
}
}
}
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
thingKey/thingId | String | Yes | Key of the Thing |
apn | String | The Access Point Name to be used for the update | |
ftpServer | String | Yes | The server where the firmware file for the update is located. |
ftpUser | String | Yes | The username to be used to access the FTP server. |
ftpPassword | String | Yes | The password to be used to access the FTP server. |
ftpPath | String | The path to the firmware update file on the FTP server. | |
fileName | String | Yes | The name of the file containing the firmware update. |
postUpdateDelay | Integer | The amount of time (in seconds) to wait for the device to process the update. Defaults to 300 seconds (5 minutes). |
TR50 Response
If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.