5.2.1 api firmware

Funkce api/firmware umožňuje nahrát soubor s firmwarem za účelem upgradování nebo downgradování.

Metody

  • PUT

Služby a privilegia

  • Služby: Systém API

  • Privilegia: Systém – řízení


Požadavek PUT

Požadavek obsahuje soubor ve formátu multipart/form-data.

Tabulka 1. Parametry požadavku
ParametrPovinnýOčekávané hodnotyVýchozí hodnotaPopis

blob-fw

Ano

platný firmwarový binární soubor

-

Soubor s firmwarem


Příklad požadavku PUT

http://192.168.1.1/api/firmware

Odpověď na PUT

Odpověď je ve formátu application/json. Obsahuje klíče success a result. Hodnota result obsahuje různé klíče popsané v následující tabulce.

Tabulka 2. Klíče odpovědi JSON
KlíčTypické vrácené hodnotyPopis

fileId

náhodný identifikátor (8 HEX znaků)

Obsahuje náhodný identifikátor nahraného souboru s firmwarem. Identifikátor musí být použit k potvrzení nahraného firmwaru pomocí funkce api/firmware/apply nebo k odmítnutí nahraného firmwaru pomocí funkce api/firmware/reject.

version

Řetězec s identifikací verze

major.minor.patch.build.id

Obsahuje identifikaci verze nahraného firmwaru.

downgrade

true nebo false

Tento příznak je true, jestliže má nahraný firmware nižší verzi, než je právě v zařízení.

note

Řetězec s náhradními znaky (URL kódování)

Obsahuje aktualizační zprávu pro nahraný firmware (např. varování před velkými změnami).

Příklad odpovědi na PUT

{ "success" : true, "result" : { "fileId" : "7d6adf16", "version" : "2.32.4.41.2", "downgrade" : false, "note" : "EN:\r\nVER=2.20.0\r\nSome changes associated with the downgrade to a lower version result in a loss of original settings in a certain part of configuration.\r\n\r\n* All the cards installed in the **Directory \/ Access cards** menu are moved to the **Directory \/ Users** menu as new users upon firmware upgrade. Each user is automatically named as !Visitor #n, where n gives the user number in the list. This change is irreversible upon downgrade.\r\n* Service cards are now available in the **Hardware \/ Card reader** menu.\r\n* All the user access ... ... ... \u043F\u0440\u043E\u0444\u0438\u043B\u0435\u043C \u043F\u043E\u043B\u044C\u0437\u043E\u0432\u0430\u0442\u0435\u043B\u044F.\r\n\r\n" } }

Vrátit se mohou tyto konkrétní chybové kódy:

  • Error code 12

    • param = "blob-fw"

    • popis = "neplatná hodnota parametru"

    • Nahraný firmware neodpovídá požadavkům (neplatný soubor, firmware pro jiné zařízení…)

  • Error code 19

    • popis = "verze souboru je nižší než požadovaná minimální verze"

    • Nahraný firmware má nižší verzi, než je pro zařízení povolena.


Upozornění

Zařízení neodpovídá na požadavky na nahrání dalšího firmwaru, když v něm existuje předchozí verze. Nejprve s pomocí funkce api/firmware/reject odmítněte předchozí verzi firmwaru a pak nahrajte jinou. Nahraný firmware bude za 5 minut automaticky odmítnut, pokud se nepoužije.