FAQ Desktop - Button

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.

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.

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.

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.

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

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

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

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  

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

As the Label, the Caller-ID is a text in UTF-8 format that is associated with the button. Typically, this text is longer than the Label and displayed in a different part of the device.

caller= "i=" text CRLF

The direction for a call can be inbound or outbound. The direction depends on the monitored resource.

direction= "b=" ("in" / "out") CRLF

The Display-Name is a text in UTF-8 format that is associated with the button. Typically, this text is used for the person’s name that is associated with the extension.

display-name= "d=" text CRLF

Then the user presses the key, the device will either dial a number or send a message to the registrar.

• If the Action is set to "invite", then the devices initiates a call. The destination of the call is provided in the Number property.
• If the Action is set to "message", then the device will send an instant message to the provided number. The message will not contain any message; the destination must be able to tell by the number what the action’s purpose is.

The default for this property is "invite". The Number tells the device what number to dial. If the Number is not available, the device will not perform any action.

action= "a=" ("invite" / "message") CRLF

destination= "n=" text CRLF

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: 53

k=3
c=on
o=orange
l=Orange LED  
a=invite
n=1003