Просмотр кода страницы Пользовательские свойства

Расширения Ключ-АСТРОМ позволяют отправлять пользовательские свойства отслеживаемой технологии как на уровне устройства, так и на уровне группы устройств. Свойство имеет форму пары ключ-значение, где оба являются строками.

Чтобы отправить свойство, используйте метод ''report_property(key="Key", value="Value")'' :

<code>group.report_property(key='Group version', value="0.5")</code>

или

<code>node.report_property(key='Device version', value="2.3")</code>

В следующем примере представлен полный код расширения:

<code>import json</code>

<code>import requests</code>

<code>from ruxit.api.base_plugin import RemoteBasePlugin</code>

<code>import logging</code>

<code>logger = logging.getLogger(__name__)</code>

<code>class DemoPluginRemote(RemoteBasePlugin):</code>

<code>    def initialize(self, **kwargs):</code>

<code>        config = kwargs['config']</code>

<code>        logger.info("Config: %s", config)</code>

<code>        self.url = config["url"]</code>

<code>    def query(self, **kwargs):</code>

<code>        # Collect stats</code>

<code>        stats = json.loads(requests.get(self.url).content.decode())</code>

<code>        # Create group - provide group id used to calculate unique entity id in astromkey</code>

<code>        #   and display name for UI presentation</code>

<code>        group = self.topology_builder.create_group(identifier="DemoGroup",</code>

<code>                                                   group_name="ActiveGate Demo Group")</code>

<code>        # report group custom property - any string-string values pair. It is added to device group metadata displayed in astromkey UI</code>

<code>        group.report_property(key='Group custom property: version', value=stats['version'])</code>

<code>        logger.info("1. Group custom property")</code>

<code>        # Create node - provide node id used to calculate unique entity id in astromkey</code>

<code>        #   and display name for UI presentation</code>

<code>        node = group.create_element(identifier="DemoNode",</code>

<code>                                    element_name="ActiveGate Demo Node")</code>

<code>        logger.info("Topology: group name=%s, node name=%s", group.name, node.name)</code>

<code>        # report property - any string-string values pair. It is added to device metadata displayed in astromkey UI</code>

<code>        node.report_property(key='Device custom property: version', value=stats['version'])</code>

<code>        logger.info("2. Device custom property")</code>

Никаких особых правок в <code>plugin.json</code>файле не требуется.

См. пример пользовательских свойств, сообщаемых на уровне группы устройств и устройств:

Модуль плагина АктивногоШлюза ограничивает объем данных (настраиваемые свойства и слишком длинные строки), отправляемых на сервер Ключ-АСТРОМ. Ограничение установлено на уровне 100 пользовательских свойств, отправленных в течение 24 часов. Строка ключа одного свойства не может содержать более 50 символов. Строка значения одного свойства не может быть длиннее 140 символов. Свойства сообщаются в пакетах, длина одного пакета не может превышать 5120 символов.