Manual:System/LEDS: Difference between revisions

From MikroTik Wiki
Jump to navigation Jump to search
← Older edit
 
(13 intermediate revisions by 2 users not shown)
Line 61: Line 61:
{{Mr-arg-table-end
{{Mr-arg-table-end
|arg=type
|arg=type
|type=ap-cap{{!}} flash-access {{!}} interface-activity {{!}} interface-receive {{!}} interface-speed {{!}} interface-status {{!}} interface-transmit {{!}} modem-signal {{!}} off {{!}} on {{!}} poe-out {{!}} wireless-signal-strength {{!}} wireless-status
|type=align-down {{!}} align-left {{!}} align-right {{!}} align-up {{!}} ap-cap {{!}} fan-fault {{!}} flash-access {{!}} interface-activity {{!}} interface-receive {{!}} interface-speed {{!}} interface-speed-1G {{!}} interface-speed-25G {{!}} interface-status {{!}} interface-transmit {{!}} modem-signal {{!}} modem-technology {{!}} off {{!}} on {{!}} poe-fault {{!}} poe-out {{!}} wireless-signal-strength {{!}} wireless-status
|default=
|default=
|desc=Type of the status:
|desc=Type of the status:
* <var>ap-cap</var> - blink on CAP initialising with CAPsMAN, steady on once connected
* <var>align-down</var> - light the led if the w60g device needs to be aligned downwards for the best signal quality
* <var>align-left</var> - light the led if the w60g device needs to be aligned to the left
* <var>align-right</var> - light the led if the w60g device needs to be aligned to the right
* <var>align-up</var> - light the led if the w60g device needs to be aligned upwards
* <var>ap-cap</var> - blink on CAP initializing with CAPsMAN, steady on once connected
* <var>fan-fault</var> - light the led when any of the device controlled fans stop working
* <var>flash-access</var> - blink the led on flash access
* <var>flash-access</var> - blink the led on flash access
* <var>interface-activity</var> - blink the led on interface (traffic) activity
* <var>interface-activity</var> - blink the led on interface (traffic) activity
* <var>interface-receive</var> - blink the led on interface received traffic
* <var>interface-receive</var> - blink the led on interface received traffic
* <var>interface-speed</var> - light the led when interface works in 10Gbit rate
* <var>interface-speed</var> - light the led when interface works in 10Gbit rate
* <var>interface-speed-1G</var> - light the led when interface works in 1Gbit rate
* <var>interface-speed-25G</var> - light the led when interface works in 25Gbit rate
* <var>interface-status</var> - light the led on interface status change
* <var>interface-status</var> - light the led on interface status change
* <var>interface-transmit</var> - blink the led on interface transmitted traffic
* <var>interface-transmit</var> - blink the led on interface transmitted traffic
* <var>modem-signal</var> - blink the led on 3G modem signal (eiher USB or miniPCIe)
* <var>modem-signal</var> - blink the led on 3G modem signal (either USB or miniPCIe)
* <var>modem-technology</var> - turns on leds in order of modem technology generation: GSM; 3G; LTE; single led turns on only when LTE is active.
* <var>off</var> - turn off the led
* <var>off</var> - turn off the led
* <var>on</var> - turn on the led
* <var>on</var> - turn on the led
* <var>poe-fault</var> - light the led when PoE out budget is close to the maximum supported limit
* <var>poe-out</var> - light the led when interface PoE out turns on
* <var>poe-out</var> - light the led when interface PoE out turns on
* <var>wireless-signal-strength</var> - light the leds displaying wireless signal (requires more than one led)
* <var>wireless-signal-strength</var> - light the leds displaying wireless signal (requires more than one led)
Line 82: Line 91:
==Leds Setting==
==Leds Setting==


Global settings are stored in Leds Setting menu. Currently "'''RB cAP 2n'''" and "'''RB cAP 2nD'''" supports turning off all leds (LED dark mode).
Global settings are stored in Leds Setting menu.  
 
<p id="shbox"><b>Sub-menu:</b> <code>/system leds setting</code></p><br />
<p id="shbox"><b>Sub-menu:</b> <code>/system leds setting</code></p><br />


Line 99: Line 107:
}}
}}


==Basic examples==


Enable the User ACT LED to show current CAP status on a RB951
The listed devices support turning off their LEDs (LED dark mode), however some LEDs still cannot be turned off due to the device design factors.
<pre>
 
/system leds
 
add leds=user-led type=ap-cap
'''Indoor devices''' <br>
</pre>
 
<table class="styled_table">
<tr>
  <th width="300">RouterBoard</th>
  <th width="300">LED description</th>
</tr>
<tr>
  <td ><b>RBcAP2n; RBcAP2nD (cAP)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBcAPGi-5acD2nD (cAP ac)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBwsAP5Hac2nD (wsAP ac lite)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RB760iGS (hEX S)</b></td>
  <td >Turns off Power LED and SFP LED</td>
</tr>
<tr>
  <td ><b>CRS305-1G-4S+</b></td>
  <td >Turns off all LEDs except Ethernet LED and Power LED</td>
</tr>
<tr>
  <td ><b>CRS309-1G-8S+</b></td>
  <td >Turns off all LEDs except Ethernet LEDs</td>
</tr>
<tr>
  <td ><b>RB951Ui-2HnD</b></td>
  <td >Turns off all LEDs except Power LED</td>
</tr>
<tr>
  <td ><b>RB951Ui-2nD (hAP); RB952Ui-5ac2nD (hAP ac lite); RB952Ui-5ac2nD-TC (hAP ac lite TC)</b></td>
  <td >Turns off all LEDs except Power LED</td>
</tr>
<tr>
  <td ><b>RB962UiGS-5HacT2HnT (hAP ac)</b></td>
  <td >Turns off all LEDs except Port5 PoE LED</td>
</tr>
<tr>
  <td ><b>RBD52G-5HacD2HnD-TC (hAP ac^2)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBD25G/RB25GR-5HPacQD2HPnD (Audience)</b></td>
  <td >Turns off all LEDs except Ethernet LEDs</td>
</tr>
<tr>
  <td ><b>RBD53iG-5HacD2HnD  (hAP ac^3)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBD53G-5HacD2HnD-TC (Chateau)</b></td>
  <td >Turns off all LEDs</td>
</tr>
</table>
 
'''Wireless Systems''' <br>
 
<table class="styled_table">
<tr>
  <th width="300">RouterBoard</th>
  <th width="300">LED description</th>
</tr>
<tr>
  <td ><b>RBwAPG-60ad (Wireless Wire)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBLHGG-60ad (Wireless Wire Dish)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBSXTsq-60ad (SXTsq Lite60); RBCube-60ad (Cube Lite60)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RB912UAG-6HPnD (BaseBox 6)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RB912R-2nD-LTm (ltAP mini / ltAP mini LTE kit)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBLtAP-2HnD (LtAP)</b></td>
  <td >Turns off all LEDs except Ethernet LEDs</td>
</tr>
<tr>
  <td ><b>RBLHG2nD (LHG 2); RBLHG2nD-XL (LHG XL 2)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBLHG5nD (LHG 5); RBLHG5HPnD (LHG HP5); RBLHG5HPnD-XL (LHG XL HP5)</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBLHGG-5acD (LHG 5 ac); RBLHGG-5acD-XL (LHG XL 5 ac); RBLHGG-5HPacD2HPnD (LHG XL 52 ac); RBSXTsqG-5acD (SXTsq 5 ac)</b></td>
  <td >Turns off all LEDs except Ethernet LED</td>
</tr>
<tr>
  <td ><b>RBLDF-2nD (LDF 2); RBLDF-5nD (LDF 5); RBLHGR</b></td>
  <td >Turns off all LEDs</td>
</tr>
<tr>
  <td ><b>RBLDFG-5acD (LDF 5 ac)</b></td>
  <td >Turns off all LEDs except Ethernet LED</td>
</tr>
<tr>
  <td ><b>RBwAPGR-5HacD2HnD (wAP ac)</b></td>
  <td >Turns off all LEDs except Ethernet LED</td>
</tr>
</table>
 
==Basic example==


Led control via CLI commands for scripting purposes:
Led control via CLI commands for scripting purposes:
Line 124: Line 248:
or
or
/system leds set [find where leds="led1"] type=off
/system leds set [find where leds="led1"] type=off
</pre>
Enable the User ACT LED to show current CAP status on a RB951
<pre>
/system leds
add leds=user-led type=ap-cap
</pre>
==Modem Signal Strength example==
The whole modem-signal strength range is [-113..-51] and the modem-signal-threshold increases the weakest signal limit to -91 so the signal range for LED indication is [-91..-51]. That range is divided into equal parts depending on number of LEDs configured for modem-signal LED trigger. The first LED turns on when signal is above -91 and the last LED turns on when signal reaches -51.
<pre>
/system leds
add interface=lte1 leds=led1,led2,led3,led4,led5 modem-signal-treshold=-91 type=modem-signal
</pre>
==Modem Access Technology example==
These LED trigger examples turn on LEDs in order of modem technology generation: GSM; 3G; LTE.
* 1 LED: led1 turns on when LTE is active;
<pre>
/system leds
add interface=lte1 leds=led1 modem-type=modem-technology
</pre>
* 2 LEDs: led1 - 3G; led2 - LTE;
<pre>
/system leds
add interface=lte1 leds=led1,led2 modem-type=modem-technology
</pre>
* 3 LEDs: led1 - GSM; led2 - 3G; led3 - LTE
<pre>
/system leds
add interface=lte1 leds=led1,led2,led3 modem-type=modem-technology
</pre>
</pre>


Latest revision as of 09:31, 8 January 2021

Applies to RouterOS: v5 +

Summary

RouterOS allows to configure each leds activity the way that user wishes. It is possible to configure the leds to display wireless strength, blink the leds on interface traffic activity and many other options.

For example default led configuration on Groove 

[admin@MikroTik] /system leds> print 
Flags: X - disabled 
 #   TYPE                     INTERFACE                   LEDS                 
 0   wireless-signal-strength                             led1                 
                                                          led2                 
                                                          led3                 
                                                          led4                 
                                                          led5                 
 1   interface-activity       ether1                      user-led

RB Groove uses five leds for wireless strength and one for ethernet activity monitoring.

Leds

Sub-menu: /system leds


Property Description
disabled (yes | no; Default: no) Whether item is disabled
interface (string; Default: ) Name of the interface which will be used for led status. Applicable only if type is interface specific.
modem-signal-treshold (integer [-113..-51]; Default: ) Applicable if type is modem-signal
leds (list of leds; Default: ) List of led names used for status report. For example wireless signal strength will require more than one led.
type (align-down | align-left | align-right | align-up | ap-cap | fan-fault | flash-access | interface-activity | interface-receive | interface-speed | interface-speed-1G | interface-speed-25G | interface-status | interface-transmit | modem-signal | modem-technology | off | on | poe-fault | poe-out | wireless-signal-strength | wireless-status; Default: ) Type of the status:
  • align-down - light the led if the w60g device needs to be aligned downwards for the best signal quality
  • align-left - light the led if the w60g device needs to be aligned to the left
  • align-right - light the led if the w60g device needs to be aligned to the right
  • align-up - light the led if the w60g device needs to be aligned upwards
  • ap-cap - blink on CAP initializing with CAPsMAN, steady on once connected
  • fan-fault - light the led when any of the device controlled fans stop working
  • flash-access - blink the led on flash access
  • interface-activity - blink the led on interface (traffic) activity
  • interface-receive - blink the led on interface received traffic
  • interface-speed - light the led when interface works in 10Gbit rate
  • interface-speed-1G - light the led when interface works in 1Gbit rate
  • interface-speed-25G - light the led when interface works in 25Gbit rate
  • interface-status - light the led on interface status change
  • interface-transmit - blink the led on interface transmitted traffic
  • modem-signal - blink the led on 3G modem signal (either USB or miniPCIe)
  • modem-technology - turns on leds in order of modem technology generation: GSM; 3G; LTE; single led turns on only when LTE is active.
  • off - turn off the led
  • on - turn on the led
  • poe-fault - light the led when PoE out budget is close to the maximum supported limit
  • poe-out - light the led when interface PoE out turns on
  • wireless-signal-strength - light the leds displaying wireless signal (requires more than one led)
  • wireless-status - light the led on wireless status change.

Leds Setting

Global settings are stored in Leds Setting menu.

Sub-menu: /system leds setting


Property Description
all-leds-off (after-1h | after-1min | immediate | never; Default: never) Whether and when all leds of router can be turned off


The listed devices support turning off their LEDs (LED dark mode), however some LEDs still cannot be turned off due to the device design factors.


Indoor devices

RouterBoard LED description
RBcAP2n; RBcAP2nD (cAP) Turns off all LEDs
RBcAPGi-5acD2nD (cAP ac) Turns off all LEDs
RBwsAP5Hac2nD (wsAP ac lite) Turns off all LEDs
RB760iGS (hEX S) Turns off Power LED and SFP LED
CRS305-1G-4S+ Turns off all LEDs except Ethernet LED and Power LED
CRS309-1G-8S+ Turns off all LEDs except Ethernet LEDs
RB951Ui-2HnD Turns off all LEDs except Power LED
RB951Ui-2nD (hAP); RB952Ui-5ac2nD (hAP ac lite); RB952Ui-5ac2nD-TC (hAP ac lite TC) Turns off all LEDs except Power LED
RB962UiGS-5HacT2HnT (hAP ac) Turns off all LEDs except Port5 PoE LED
RBD52G-5HacD2HnD-TC (hAP ac^2) Turns off all LEDs
RBD25G/RB25GR-5HPacQD2HPnD (Audience) Turns off all LEDs except Ethernet LEDs
RBD53iG-5HacD2HnD (hAP ac^3) Turns off all LEDs
RBD53G-5HacD2HnD-TC (Chateau) Turns off all LEDs

Wireless Systems

RouterBoard LED description
RBwAPG-60ad (Wireless Wire) Turns off all LEDs
RBLHGG-60ad (Wireless Wire Dish) Turns off all LEDs
RBSXTsq-60ad (SXTsq Lite60); RBCube-60ad (Cube Lite60) Turns off all LEDs
RB912UAG-6HPnD (BaseBox 6) Turns off all LEDs
RB912R-2nD-LTm (ltAP mini / ltAP mini LTE kit) Turns off all LEDs
RBLtAP-2HnD (LtAP) Turns off all LEDs except Ethernet LEDs
RBLHG2nD (LHG 2); RBLHG2nD-XL (LHG XL 2) Turns off all LEDs
RBLHG5nD (LHG 5); RBLHG5HPnD (LHG HP5); RBLHG5HPnD-XL (LHG XL HP5) Turns off all LEDs
RBLHGG-5acD (LHG 5 ac); RBLHGG-5acD-XL (LHG XL 5 ac); RBLHGG-5HPacD2HPnD (LHG XL 52 ac); RBSXTsqG-5acD (SXTsq 5 ac) Turns off all LEDs except Ethernet LED
RBLDF-2nD (LDF 2); RBLDF-5nD (LDF 5); RBLHGR Turns off all LEDs
RBLDFG-5acD (LDF 5 ac) Turns off all LEDs except Ethernet LED
RBwAPGR-5HacD2HnD (wAP ac) Turns off all LEDs except Ethernet LED

Basic example

Led control via CLI commands for scripting purposes:

  • prior to v6.23 and older releases:
#turn led on
:led led1=yes
#turn led off
:led led1=no
  • v6.23 and newer releases:
#add led entry with specific type "on" or "off" to leds menu
/system leds add leds=led1 type=off
#to control led
/system leds set [find where leds="led1"] type=on
or
/system leds set [find where leds="led1"] type=off

Enable the User ACT LED to show current CAP status on a RB951 

/system leds
add leds=user-led type=ap-cap

Modem Signal Strength example

The whole modem-signal strength range is [-113..-51] and the modem-signal-threshold increases the weakest signal limit to -91 so the signal range for LED indication is [-91..-51]. That range is divided into equal parts depending on number of LEDs configured for modem-signal LED trigger. The first LED turns on when signal is above -91 and the last LED turns on when signal reaches -51. 

/system leds
add interface=lte1 leds=led1,led2,led3,led4,led5 modem-signal-treshold=-91 type=modem-signal

Modem Access Technology example

These LED trigger examples turn on LEDs in order of modem technology generation: GSM; 3G; LTE.

  • 1 LED: led1 turns on when LTE is active;
/system leds
add interface=lte1 leds=led1 modem-type=modem-technology
  • 2 LEDs: led1 - 3G; led2 - LTE;
/system leds
add interface=lte1 leds=led1,led2 modem-type=modem-technology
  • 3 LEDs: led1 - GSM; led2 - 3G; led3 - LTE
/system leds
add interface=lte1 leds=led1,led2,led3 modem-type=modem-technology

[ Top | Back to Content ]

Retrieved from "https://wiki.mikrotik.com/index.php?title=Manual:System/LEDS&oldid=34307"