wb_editors
14 355
правок
(Новая страница: «== Templates ==») |
FuzzyBot (обсуждение | вклад) м (FuzzyBot переименовал страницу Драйвер SNMP/en в SNMP/en без оставления перенаправления: Часть переводимой страницы Драйвер SNMP.) |
||
(не показано 13 промежуточных версий 1 участника) | |||
Строка 158: | Строка 158: | ||
== Templates == | == Templates == | ||
It is convenient (though not necessary) to use templates to describe devices. The template (device type) is an external configuration file (located in /usr/share/wb-mqtt-snmp/templates and named config-[device-type-name].json, for example, config-test-snmp.json), which contains a basic description of the device (such as the SNMP community name) and a basic description of all its channels. | |||
To use the template in the device description in the configuration file, specify the field ''''device_type''''. Among all presented templates, a template with the same ''device_type'' value will be selected, and all fields that were not defined in the configuration file will take values from the template. | |||
It works the same way with channels. The channels are compared by the mandatory field name; if the channel name from the configuration file matches the channel name in the template, all unspecified values will be taken from the template. | |||
=== | === Example === | ||
Config-my-device.json template: | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
Строка 189: | Строка 186: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Configuration file: | |||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
Строка 215: | Строка 212: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
In this case, we have described one my-device template, by which we have defined two different devices Device 1 and Device 2 with the same set of channels. | |||
In this case, we have described one my-device template, by which we have defined two different devices Device 1 and Device 2 with the same set of channels. | |||
Since Device 1 is on the local network, it is logical to set it a small timeout value to quickly determine the malfunction of the device. All other settings are taken from the template. | |||
Device 2 and the remote server, because for him, it is necessary to increase the timeout to not think the device is faulty if the delay of the package. What's more, for channel 2 here, we are redefining the polling interval to a larger one to reduce the load on the network. | |||
So, it is very convenient to use templates to describe a group of similar devices. | |||
= Template list = | |||
The WB-mqtt-snmp package includes a set of templates for typical devices (the list will be expanded): | |||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! | ! Device !! Template !! Tested !! Comments | ||
|- | |- | ||
| | | Test server Net-SNMP || test-snmp || style="background: #22EE44;" | Yes || Test server address test.net-snmp.org | ||
|- | |- | ||
| APC UPS || apc-ups || Нет || | | APC UPS || apc-ups || Нет || | ||
* | * Requires locally installed PowerNet-MIB | ||
* | * The device description is the same as in wb-mqtt-apcsnmp | ||
|- | |- | ||
|} | |} |