A button has several properties which are described below. It is not necessary that all buttons support all features. For example, it is possible that a phone has LED lights and keys, but no display associated with the button.


Lamp

One lamp can render one color at a time. It must have at least a "on" and an "off" state, and it may have additional features like colors. It has the possibility to indicate further information by slow and fast blinking. Typically, a lamp is implements with a LED diode.


Label

A key might have a small display next to it, called a "label". Some devices support this feature, so that the user does not have to print a label on paper for the key. This display can be used to provide additional information to the lamp, for example the extension number or the function of the key.


Key

The key has two states, up and down. The user can push the key and release the key. The key is associated with a lamp and typically located physically next to the lamp.


Key Information

Along with the key, the device may render additional information that belongs to the key. The device that renders the information is not attached to the lamp. For example, information could be the caller-ID for an incoming call and it is displayed on the main screen of the device.


Protocol Description

Format

The document contains of CRLF - separated lines. Empty lines indicate the beginning of a new lamp description, so that one document can contain several lamp descriptions. There is no line continuation; a CRLF combination is the clear indication that the line ends. Each line may contain description entries for the lamp. If an entry is not present, then a default value shall apply. The previously stored value for that property will be overwritten in any case. Text is encoded in UTF-8 format. It may not contain special characters like CR, LF or TAB; but it may contain space and UTF-8 encoded characters.

With notepad++

  • Encoding convert to UTF-8
  • Edit - EOL conversion to Windows (CR LF)

Name

The Name property is used to identity the button that should be changed. The name itself is a text. Gigaset phones can handle numbers from 1 to MaxNumbersOfLinekeys

name= "k=" text CRLF

e.g: k=3

Light

The Light property describes in what state the lamp should be. There is a set of predefined light modes that any device must support:

  • "on" should turn the light (RED) on without any blinking.

  • "off" should turn the light off without any blinking.

  • "hold" indicates that there is a call on hold associated with the button. (RED blinking)

  • "pickup" indicates that there is a ringing call that can be picked up. (RED fast blinking)

  • "park" indicates that there is a call that can be retrieved from a park orbit. (RED blinking using park blinking sequence)

  • "message" is used to indicate that there is a message waiting. (RED blinking using message blinking sequence

light= "c=" ("off" / "on" / "hold" / "pickup" / "park"/ "message") CRLF

e.g: c=on

Color

Valid colors values are:

  • "local" (which will light up green)

  • "remote" ( = red)

  • "red"

  • "green"

  • "orange"

color= "o=" ("local" / "remote" / "red" / "green" / "red") CRLF

e.g: o=orange

Label

The Label property is usually a short text like "234" or "DND". The text for the label is encoded in UTF-8 format. Devices that do not support the complete UTF-8 character set must select a reasonable replacement for characters that cannot be displayed.

label= "l=" text CRLF

e.g: l=Orange LED

Examples

Sipsak Example

This example shows how you can turn the LED from Function key 1 on (or off)

Phone configuration:

Setup Function key 3 in "Function Keys" as in the following image:


Set in your identity configuration, on SIP tab "Support broken Registrar" to on:

Set in the advanced configuration, on SIP/RTP tab "Network identity (port):" to 5060:

Set in the advanced configuration, on QoS/Security tab " Filter Packets from Registrar:" to off:

Your device needs to be rebooted !!!

In this example the phone have the IP-address 192.168.1.207, the PC where sipsak is installed have the IP-address 192.168.1.192.

Create a file with the name led.txt and the following content:


MESSAGE $user$@$dsthost$;transport=udp SIP/2.0
From: sip:sipsak@$srchost$:1036;tag=38473
To: $user$@$dsthost$
Call-ID: 6algjorv@test
CSeq: 59620 MESSAGE
Max-Forwards: 70
Contact: < $user$@$dsthost$;transport=udp>
Subject: buttons
Content-Type: application/x-buttons
Content-Length: 32

k=3
c=on
o=orange
l=Orange LED

The value "Content-Length:" must be the count of every following character and all CR.

Now you can use the created file with sipsak to send the notify to the phone:

sipsak -G --hostname 192.168.0.12 -s sip:<identity>@192.168.0.11 --filename led.txt

sipsak -G --hostname 192.168.1.207 -s sip:1015@192.168.1.192 --filename led.txt

Remember to set <identity> to whatever is your identity in your phone, e.g. 1015.