file_distribution_start

_^Tech

Starts file distribution to the receiver devices.

Params

attribute	description
receiver_group* 'A'|'B'|'C'|'D'	The receiver device group to which the firmware will be send
maxrate* unsigned int	The maximum transmission speed in Kib/s. Allowed values are returned by device_constants_get.
losslimit* unsigned int	The maximum acceptable packet loss as percentage. Allowed values are returned by device_constants_get.
repository* Repository	The repository from which to distribute the file

Example

{
  "receiver_group": "C",
  "maxrate": 12,
  "losslimit": 2,
  "repository": "mbm_fw"
}

Return

attribute	description
state 'running'|'inactive'|'paused'	Receiving state of the device.
repository Repository	The repository holding the distributed file. Mandatory when state is 'running' or 'paused'.
receiver_group 'A'|'B'|'C'|'D'	The receiver device group.Mandatory when state is 'running' or 'paused'.
maxrate unsigned int	The maximum transmission speed in Kib/s. Mandatory when state is 'running' or 'paused'.
losslimit unsigned int	The maximum acceptable packet loss as percentage. Mandatory when state is 'running' or 'paused'.
progress unsigned int	Indicates in percent the overall uploaded progress. The number is a rough approximation and can both increase and decrease.
receivers [Receiver]	An array of receiver devices.Mandatory when state is 'running' or 'paused'.
start_time unsigned int	Unix timestamp when the last send process started. Mandatory when state is 'running' or 'paused'.
end_time unsigned int	Unix timestamp when the last send process finished. If a send process is in progress must be null.
end_status 'aborted'|'complete'|'failed'	End status of the last send process. If a send process is in progress it must be null.

Receiver

attribute	description
ip* string	The device radio IPv4 address
state* 'running'|'unresponsive'|'aborted'|'done'	The receiving status of the receiver device

Example

{
  "state": "sending",
  "repository": "mbm_fw",
  "receiver_group": "A",
  "maxrate": 12,
  "losslimit": 2,
  "progress": 10,
  "receivers": [
    {
      "ip": "1.1.1.1",
      "state": "receiving"
    },
    {
      "ip": "1.1.1.2",
      "state": "done"
    }
  ],
  "start_time": 1660367142
}