Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tip

Manage devices using gRPC API methods (ConfigurationService)

Axxon One configuration settings are described in the ConfigurationService.proto proto file.

There are 2 methods used:

  1. Changeconfig.
  2. ListConfig.

ChangeConfig method

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

  1. added - an array of units that should be added;
  2. changed - an array of units that units that should be changed;
  3. remove - an array of units that units that should be removed.

Unit structure

...

A unit can contain subunits (the units field). For example, a VideoChannel.0 unit may have a child unit Streaming.0.

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.

...

In response to the method, the following data will be received:

  1. failed - the units that could not be added.
  2. added - the uid of the successfully added unit.

...

  1. units is a list of successfully found units.;
  2. unreachable_objects is a list of temporarily unavailable units.;
  3. not_found_objects is a list of not found units.

...

factory are included units that can be created for a given unit. The available fields are:

  • type - a type of subunit that can be created.
  • properties - a list of subunit properties.