Go to documentation repository
Page History
Tip |
---|
Manage devices using Zarządzaj urządzeniami za pomocą metod gRPC API methods (ConfigurationService) |
Konfigurowanie ustawień Axxon Next configuration settings are described in the jest opisane w proto-pliku ConfigurationService.protoproto file.
There are 2 methods usedSą dostępne 2 metody:
- Changeconfig
- ListConfig
Metoda ChangeConfig
...
The ChangeConfig method allows to create, edit and delete any system objects.
Hereinafter, any system object or element will be called a unit.
Input data
- added - an array of units that should be added
- changed - an array of units that should be changed
- remove - an array of units that should be removed.
Unit structure
The type field determines what a unit is.
A unit can contain subunits (the units field). For example, a VideoChannel.0 unit may have a child unit Streaming.0.
Metoda ChangeConfig pozwala na tworzenie, edycję oraz usuwanie obiektów systemowych.
Obiekty systemowy lub elementy będą zwane dalej jednostkami (unit).
Dane wejściowe
- added - tablica zawierająca jednostki, które powinny zostać dodane;
- changed - tablica zawierająca jednostki, które powinny zostać zmienione;
- 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ęEach unit has a uid field - it is a unit identifier, which consists of all the "parents" of the unit, separated by the "/" symbol. For example, the uid field of the Streaming.0 unit will be as follows: hosts/Node1/DeviceIpint.1/VideoChannel.0/Streaming.0.
WhereGdzie:
- uid starts with rozpoczyna się od "hosts",
- Node1 is the node name to nazwa węzła,
- DeviceIpint.1 is the device name to nazwa urządzenia,
- VideoChannel.0 is the first video channel of the camera to pierwszy kanał wideo kamery,
- Streaming.0 is the first video stream of the channel.
In addition, a unit can contain any number of settings in the properties field.
Output data
In response to the method, the following data will be received:
- failed - the units that could not be added.
- added - the uid of the successfully added unit.
ListConfig method
The method allows to get a list of units.
Input data
unit_uids is an array of the units' uids to be obtained.
Output data
- 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:
- failed - jednostki, które nie mogły zostać dodane.
- 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
- units to lista poprawnie znalezionych jednostek.
- unreachable_objects to lista tymczasowo niedostępnych jednostek
- units is a list of successfully found units.
- unreachable_objects is a list of temporarily unavailable units.
- not_found_objects is a list of not found unitsto lista nieznalezionych obiektów.
The units field is of UnitDescriptor typePole units jest typu UnitDescriptor.
uid is a unit identifier, which consists of all the "parents" of the unit, separated by the "/" symbol. For example, the uid field of the Streaming.0 unit will be as follows 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 is a short id, which is usually unique in a parent scope. For example, for a to krótkie ID, które zwykle jest unikalne w grupie podjednostek rodzica. Dla przykładu, dla jednostki DeviceIpint.1 unit, the field pole display_id == 1 (sometimes type can go together with itw niektórych przypadkach pole type także może być umieszczone).
type is a unit type. For example, for a to typ jednostki. Przykład: dla jednostki DeviceIpint.1 unit, the field pole type == DeviceIpint.
properties is a list of unit settings. 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 tounits are included units that can have either a full description or a short one. In this case, the field stripped == true, and the only fields that are available from the description are: display_id, type, uid.
factory are included units that can be created for a given unit. The available fields are: 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
- type - a type of subunit that can be created.
- properties - a list of subunit properties.