LEDs Behavior

These are all the LED-controlling settings (available since versions >= 8.4.32 and >= 8.7.2)

Controlling the Line LEDs

Line-key LEDs

A line-key can be in a specific state, thats an arbitrary string assigned to it either through key-dependent rules (see fkey-subtrees -> NotifyParsingRules with type='state') or cause it is tied to a presence-information for which there are several hard-coded states:

• ocs: AVAILABLE, BUSY, IN_A_CALL, IN_A_MEETING, URGENT_INTERRUPTIONS_ONLY, HOLDING, DND, INACTIVE, BE_RIGHT_BACK, AWAY, OFFLINE and UNKNOWN
• non-ocs: AVAILABLE, UNAVAILABLE, ACTIVE, RINGING

Since 8.7.4 all buttons controlling a LED set a state, e.g. when a call is tied to a button, these state apply:

• CONNECTED, RINGING, ON_HOLD, HOLDING, CLOSED, OFFHOOK, CALLING and RINGBACK

Other hard-coded states are:

• SEIZED, PARKED, RECORDING, ON, OFF, MESSAGE, PICKUP and UNDEFINED

LED control

The LED control settings contain space-separated lists of line-key-states and keywords which list the situation the behaviour implied by the setting-name applies.

Here is the list of available LED controls:

LED-state-control

led_on
led_blink_slow
led_blink_medium
led_blink_fast
led_blink_short_off (available only on 821 and 870 for their call-indication led)

LED-color-control

led_red
led_green
led_orange
led_blue

If a state or keyword is not present in the LED-state-control settings then the LED is turned off. Only exception are the PhoneHasCallInState..-keywords. If they are not found, a second LED-state-lookup is performed using the keyword PhoneHasCall.

If a state or keyword is not present in the LED-color-control settings then the LED will use its default color, which varies with phone- and LED-type:

• line-key-LEDs are orange-only on 3xx-phones. On 820/821 they can be red, green or orange - default is red.
• call-indication-LEDs default to red on all phone-types. The MeetingPoint can also do blue. Setting this LED to orange on 820 will make it dim.
• message LED is orange-only on 300, 320 and 360 and red-only in 8xx phones. The 370 can do red and orange, default is orange.

Only exception to the use-default-if-no-found-rule again are the PhoneHasCallInState..-keywords. If they are not found, a second LED-color-lookup is performed using the keyword PhoneHasCall - only if that search is unsucessfull as well, will the above default-rule be used.

The LED-color-control settings naming two colors at once only work for the line-key-states (no keywords here). The LED-state must be set to blink to use the color-combinations. Instead of blinking on off, the blink will switch between the appropriate colors.

Note

Please be aware that the color settings are not supported on 3xx phones. You can set them values but they will be ignored.

Examples

1. If the content of 'led_blink_slow' is 'AWAY OFFLINE', the LED will blink slowly when the monitored extension's state becomes away or offline.

2. If 'led_blink_slow' is set to 'BUSY DND' and 'led_red' is set to 'BUSY IN_A_CALL', when the monitored extension's state becomes busy, the LED will blink slowly and its color will become red.

3. If 'led_blink_slow' is set to 'BUSY' and 'led_red_green' is set to 'BUSY IN_A_CALL', when the monitored extension's state becomes busy, the LED will blink slowly alternating colors red and green.

Managing the LED for BLF keys

When you configure a function key as a "BLF" or as an "Extension" the phone will SUBSCRIBE for a monitoring dialog-info to the monitored extension.

The key state will depend on the monitored extension state:

• idle: when the monitored extension is in idle: no active calls (starting from version 8.9.3.42 & 8.7.5.53, previous versions was 'undefined')
• ringing: when the monitored extension as an incoming call and is ringing
• connected: when the monitored extension as an active call
• holding: when the monitored extension is holding a call
• undefined: when the dialog subscription is not defined or an error occurred

So based on this status list you can configure the LED behaviour for a BLF key:

Examples

1. if the settings 'led_on' and 'led_green' contain the keyword 'idle' the phone key will be green when the monitored extension doesn't have any call

2. if the setting 'led_blink_slow' and 'led_orange' contain the keyword 'holding' the phone key will blink slowly in orange when the monitored extension has a call on hold

Managing the LED for shared line keys

When you configure a function key as a "Shared Line" and activate the shared line flag the phone will SUBSCRIBE to call-info events for the shared line (Broadsoft and Metaswitch only).

Starting with version 8.9.3.50 the key state will reflect the state of the shared line as follows (with default assignments in parentheses):

• sca_idle: when the shared line is idle (not assigned, off by default)
• seized_local: when the shared line was seized locally (led_on, led_green)
• seized_remote: when the shared line was seized on a secondary device (led_on, led_red)
• alerting_local: when the shared line is alerting locally (led_blink_fast, led_green)
• alerting_remote: when the shared line is alerting on a secondary device (this will happen only if the call was rejected locally) (led_blink_fast, led_red)
• active_local: when the shared line is active locally (led_on, led_green)
• active_remote: when the shared line is active on a secondary device (led_on, led_red)
• held_local: when the shared line is held locally (led_blink_slow, led_green)
• held_remote: when the shared line is held on a secondary device (led_blink_slow, led_red)
• Private hold is mapped to held_local and active_remote respectively.

Controlling the call indicator and message LEDs

Description

Using this feature you can control when the following LEDs will blink:

led_call_indicator_usage
led_message_usage

The LED usage settings contain a space separated list of keywords defining what events/states the LED described by the setting should signal:

PhoneHasCall
PhoneHasCallInState...
PhoneHasMonitoringLineKeyInStateRinging (Removed with 8.7.4)
PhoneCallIsMute
CurrentIdentityIsDnd (since 8.7.2 this is actually using status message keywords)
PhoneHasMissedCalls (since 8.7.2 this is actually using status message keywords)
CurrentIdentityHasVoiceMessages (since 8.7.2 this is actually using status message keywords)

Since 8.7.2 status message keywords can also be used.

This list is interpreted from left to right, the first keyword that applies to the current phone-state determines how the LED will behave. E.g. lets say the led_message_usage setting is set to "PhoneIsDnd PhoneHasCallInStateRinging PhoneHasMissedCalls" and the phone is not set to dnd and has an incoming (ringing) call -> the first match will be PhoneHasCallInStateRinging, whether the phone has also missed calls will not be checked. This keyword will now be used to find out from the lLED-control settings how (on/blinking/off ..) and in which color the LED should switch on. Only exception to the first-keyword-match->stop-looking-rule is the message-LED of the 370. It has two colors (red and orange) and is treated like two separate LEDs internally. In the above example if the phone also had missed calls and was set to signal those in orange with the message-LED while signaling the ringing in red, then the message LED would light orange and red at the same time.

Example

If you don't want the call indicator LED to blink when you have missed calls, set it to only turn on if the phone is ringing or is in a call:

http://<IP_ADDRESS>/dummy.htm?settings=save&led_call_indicator_usage=PhoneHasCallInStateRinging%20PhoneHasCall