Documentation for Axxon Next 4.5.0. Documentation for other versions of Axxon Next is available too.

Previous page Listy rozpoznawania  Konfigurowanie makr Next page

Zarządzaj urządzeniami za pomocą metod gRPC API (ConfigurationService)

Konfigurowanie ustawień Axxon Next jest opisane w proto-pliku ConfigurationService.proto.

Są dostępne 2 metody:

  1. Changeconfig
  2. ListConfig

Metoda ChangeConfig

Metoda ChangeConfig pozwala na tworzenie, edycję oraz usuwanie obiektów systemowych.

Obiekty systemowy lub elementy będą zwane dalej jednostkami (unit).

Dane wejściowe

  1. added - tablica zawierająca jednostki, które powinny zostać dodane;
  2. changed - tablica zawierająca jednostki, które powinny zostać zmienione;
  3. remove - tablica zawierająca jednostki, które powinny zostać usunięte.

Struktura jednostek

Pole type określa czym jest dana jednostka.

Jednostka może zawierać podjednostki (pole units). Dla przykładu, jednostka VideoChannel.0 może posiadać podjednostkę Streaming.0.

Każda z jednostek posiada pole uid - jest to identyfikator jednostki, która zawiera wszystkich "rodziców" danej jednostki, oddzielonych symbolem "/". Przykładowo, pole uid jednostki Streaming.0 będzie mieć następującą formę: hosts/Node1/DeviceIpint.1/VideoChannel.0/Streaming.0.

Gdzie:

  • uid rozpoczyna się od "hosts",
  • Node1 to nazwa węzła,
  • DeviceIpint.1 to nazwa urządzenia,
  • VideoChannel.0 to pierwszy kanał wideo kamery,
  • Streaming.0 to pierwszy strumień wideo kanału.

Jednostka może dodatkowo zawierać dowolną ilość ustawień w polu properties.

Dane wyjściowe

Jako odpowiedź do metody, następujące dane zostaną otrzymane:

  1. failed - jednostki, które nie mogły zostać dodane.
  2. added - uid prawidłowo dodanej jednostki.

Metoda ListConfig

Metoda ta pozwala na pozyskanie listy jednostek.

Dane wejściowe

unit_uids to tablica zawierająca UID jednostek, które mają zostać pozyskane.

Dane wyjściowe

  1. units to lista poprawnie znalezionych jednostek.
  2. unreachable_objects to lista tymczasowo niedostępnych jednostek.
  3. not_found_objects to lista nieznalezionych obiektów.

Pole units jest typu UnitDescriptor.

uid to identyfikator jednostki, który zawiera w sobie wszystkich "rodziców" jednostki, oddzielonych symbolem "/" Pole uid przykładowej jednostki Streaming.0 może wyglądać następująco: hosts/Node1/DeviceIpint.1/VideoChannel.0/Streaming.0.

display_id to krótkie ID, które zwykle jest unikalne w grupie podjednostek rodzica. Dla przykładu, dla jednostki DeviceIpint.1, pole display_id == 1 (w niektórych przypadkach pole type także może być umieszczone).

type to typ jednostki. Przykład: dla jednostki DeviceIpint.1 pole type == DeviceIpint.

properties to lista ustawień jednostki.

units to dołączone jednostki posiadające pełny lub krótki opis; w takim przypadku pole stripped == true, a jedyne pola dostępne z opisu to: display_id, type, uid.

factory to dołączone jednostki, które mogą być utworzone dla danej jednostki. Dostępne pola:

  • type - typ podjednostki, który może zostać utworzony.
  • properties - lista właściwości podjednostki.
  • No labels