Update Firmware

UpdateFirmwareRequest

Topic: josev/cs. Used by Josev to request the CS to update the station firmware.

type

object

properties

  • id

type

string

format

uuid

  • name

const

update_firmware

  • type

const

request

  • data

type

object

properties

  • request_id

type

integer

  • location

type

string

pattern

^(https?|ftps?|sftp)://

format

uri

  • retrieve_datetime

type

string

pattern

^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}(\.\d{1,3})?([Zz]|([+-])\d{2}:\d{2})?$

format

date-time

  • install_datetime

type

string

pattern

^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}(\.\d{1,3})?([Zz]|([+-])\d{2}:\d{2})?$

format

date-time

  • retries

type

integer

  • retry_interval

type

integer

  • signing_certificate

type

string

  • signature

type

string

Example:

{
    "id": "86bfba63-a44f-40cc-8b4b-dc4c9d771e52",
    "name": "update_firmware",
    "type": "request",
    "data": {
        "request_id": 12345,
        "location": "https://josev.s3.eu-west-2.amazonaws.com/josev.tar",
        "retrieve_datetime": "2023-04-06T15:25:51.083Z",
        "install_datetime": "2023-04-06T15:28:51.083Z", # [Optional]
        "retries": 3, # [Optional]
        "retry_interval": 60, # [Optional]
        "signing_certificate": "xxxxxx", # [Optional]
        "signature": "yyyyyy", # [Optional]
    }
}

UpdateFirmwareResponse

Topic: cs/josev. Used to acknowledge the update firmware request.

type

object

properties

  • id

type

string

format

uuid

  • name

const

update_firmware

  • type

const

response

  • data

type

object

properties

  • status

enum

accepted, rejected, accepted_canceled, invalid_certificate, revoked_certificate

Example:

{
    "id": "86bfba63-a44f-40cc-8b4b-dc4c9d771e52",
    "name": "update_firmware",
    "type": "response",
    "data": {
        "status": "accepted", # rejected, accepted_canceled, invalid_certificate, revoked_certificate
    },
}