Usm radio EN

Материал из WiKi - UserSide
Версия от 16:20, 1 ноября 2024; N.Skrypnik (обсуждение | вклад)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)

en | ru

USM_RADIO - is a module that periodically polls radio equipment, determines connected radio users and signal levels to them. If the signal level goes out of the allowed values, a notification will be displayed on the Main page of the system.


This module is a replacement for the obsolete us_radio module


IMPORTANT: The module is currently supported by radio equipment of the following manufacturers

  • MikroTik
  • UBNT
  • ELTEX
  • Cambium


If the signal strength is between -79 and -73, the notifications will be displayed in yellow colour

If the signal strength is less than -80 or more than -40, the notifications will be displayed in red.

At start-up, the module will poll all suitable radio devices.


Module Language: Perl

Current version: see page: Modules

Module Status: Paid

Required Perl modules:

Time::Local
FindBin
URI
URI::Escape
LWP::UserAgent
JSON
Data::Dumper

For general information for all modules, see the page: Modules

Installing and configuring a module

  1. Allocate a separate directory. A completely arbitrary one. It is better not to place it in a web-accessible catalogue. Interaction with ERP "UserSide" is performed by API means via http/s-protocol. Thus the module is fully autonomous and can work on any separate computer in any subnet. Also create a separate directory for the module logs. Do not forget to specify write permissions for it.
  2. Transfer there the files from the module archive. Rename the sample configuration file "usm_radio.conf-example" to "usm_radio.conf". In it, configure the parameters. The list of possible parameters is given below.
  3. Check for additional perl packages that are required to run the module. Their list is given above. If you do not have them installed, the module will generate an error at startup and the perl-package will need to be installed (using CPAN or PPM).
  4. In the "Settings - Modules" section, switch on the usm_radio module
  5. Run the module manually
perl usm_radio.pl

It should start and run without errors.

7. Write the module startup into the system cron every 30-60 minutes

Parameters

The module is configured in the usm_radio.conf file

$usUrl - URL to ERP "UserSide"
$usApiKey - API-key to ERP "UserSide"
$logsPath - Path to the directory for module logs

$isSilence - Flag - hide notifications to console when module is running

The usm_radio module can be run with the parameters (specify a specific device to poll)

Example:

perl usm_radio 998

will poll the radio equipment with ID 998

If the information is not captured/module does not work

1. It is necessary to distinguish and understand whether the module does not work or the information is not captured. In the equipment card - you should check the usm_radio module run log by device.

2. You should make sure that community access, passwords are correct and the device itself is physically connected and working.

3. In the "UserSide" ERP itself, open the equipment card and click on the "Connected radio users" link

4. To test - you should run the module specifically for a particular device. For example:

perl usm_radio.pl s 998

will start the module for equipment ID: 998

Check if there are no errors in the information output.

Analyse the received information in the log files.