\MTsigmon

MikroTik/UBNT signal monitoring class

Synopsis

class MTsigmon {

• // constants
• const URL_ME = '?module=mtsigmon';
• const CACHE_PREFIX = 'MTSIGMON_';
• const CPE_SIG_PATH = 'content/documents/wifi_cpe_sig_hist/';
• // members
• protected string $userLogin = '';
• protected string $userSwitch = '';
• protected array $deviceIdUsersMac = ;
• protected array $allUsermacs = ;
• protected array $allUserCpeMacs = ;
• protected array $allUserData = ;
• protected array $allMTDevices = ;
• protected array $allMTSnmp = ;
• protected  $cache = '';
• protected integer $cacheTime = 2592000;
• protected  $messages = '';
• protected bool $EnableQuickAPLinks = false;
• protected bool $EnableCPEAutoPoll = false;
• protected bool $WCPEEnabled = false;
• protected  $ubConfig = NULL;
• protected string $apSortOrder = "id";
• protected bool $switchGroupsEnabled = false;
• protected bool $groupAPsBySwitchGroupWithTabs = false;
• protected array $allMTSwitchGroups = ;
• protected array $existingMTSwitchGroups = ;
• // methods
• public void __construct()
• protected void initSNMP()
• protected void initLogin()
• protected void initCache()
• protected void getMTidByUserMac()
• protected array getMTDevices()
• protected array LoadUsersData()
• protected array LoadUsersCpeMACs()
• public void MTDevicesPolling()
• public array getCPESignalData()
• public string renderSignalGraphs()
• public array|string getAPEssentialData()
• protected string getMACFromSNMPStr()
• protected void deviceQuery()
• public string controls()
• public string renderMTList()
• public void renderMTListTabbed()
• public string renderMTsigmonList()
• public void useSwtichGroupsAndTabs()
• public array getAllWiFiSignals()
}


Constants

Name	Value
URL_ME	'?module=mtsigmon'
CACHE_PREFIX	'MTSIGMON_'
CPE_SIG_PATH	'content/documents/wifi_cpe_sig_hist/'

Members

protected

• $EnableCPEAutoPoll — bool
  Contains value of MTSIGMON_CPE_AUTOPOLL from alter.ini
• $EnableQuickAPLinks — bool
  Contains value of MTSIGMON_QUICK_AP_LINKS from alter.ini
• $WCPEEnabled — bool
  Is WCPE module enabled? Contains value of WIFICPE_ENABLED from alter.ini
• $allMTDevices — array
  All available MT devices
• $allMTSnmp — array
  OLT devices snmp data as id=>snmp data array
• $allMTSwitchGroups — array
  Contains array which represents sigmon devices and their groups, like: mtId => switchGroup
• $allUserCpeMacs — array
  All users CPE MAC
• $allUserData — array
  All users Data
• $allUsermacs — array
  All users MAC
• $apSortOrder — string
  Sorting order of APs in lists and dropdowns Possible values: id, ip, location
• $cache —
  UbillingCache object placeholder
• $cacheTime — int
  Comments caching time
• $deviceIdUsersMac — array
  Data DEVICE id and his array mac data
• $existingMTSwitchGroups — array
  Contains groups in which only sigmon devices are present
• $groupAPsBySwitchGroupWithTabs — bool
  Placeholder for SIGMON_GROUP_AP_BY_SWITCHGROUP_WITH_TABS alter.ini option
• $messages —
  Contains system mussages object placeholder
• $switchGroupsEnabled — bool
  Placeholder for SWITCH_GROUPS_ENABLED alter.ini option
• $ubConfig —
  Placeholder for UbillingConfig object instance
• $userLogin — string
  User login
• $userSwitch — array
  User assigned switch ID

Methods

protected

• LoadUsersCpeMACs() — Load user data, mac, adress
• LoadUsersData() — Load user data, mac, adress
• deviceQuery() — Polls wireless APs/CPEs and stores data to cache
• getMACFromSNMPStr() — Returns MAC in 'XX:XX:XX:XX:XX:XX' format from something like this: '.1.3.6.1.2.1.2.2.1.6.1 = Hex-STRING: E4 8D 8C 27 2F 7B' or Returns MAC in 'XX:XX:XX:XX:XX:XX' format from something like this: '.1.2.840.10036.1.1.1.1.5 = STRING: "00:27:22:90:11:AE"' or Returns MAC in 'XX:XX:XX:XX:XX:XX' format from something like this: '.1.3.6.1.2.1.2.2.1.6.1 = STRING: 0:c:42:da:af:4'
• getMTDevices() — Returns array of monitored MikroTik devices with MTSIGMON label and enabled SNMP
• getMTidByUserMac() — If get login set $userSwitch
• initCache() — Initalizes system cache object for further usage
• initLogin() — If get login set $userLogin
• initSNMP() — Creates single instance of SNMPHelper object

public

• __construct()
• MTDevicesPolling() — Performs available MT devices polling. Use only in remote API.
• controls() — Returns default list controls
• getAPEssentialData() — Gets essential system info about AP via SNMP and returns it as HTML table or array
• getAllWiFiSignals() — Returns array like: $userLogin => $wifiSignal
• getCPESignalData() — Performs getting string representation of AP/CPE devices signal levels from cache.
• renderMTList() — Renders available CPE JQDT list container
• renderMTListTabbed()
• renderMTsigmonList() — Renders MTSIGMON list container
• renderSignalGraphs() — Renders signal graphs for specified CPE if there are some history data already Returns ready-to-use piece of HTML
• useSwtichGroupsAndTabs()