5.7 API Updates - Duration and Interval Parameters

duration

How long the audio plays (in seconds).

Integer

Optional

This parameter is available only on firmware version 5.7 and later.

path

The file name of the tone to be played

string

Required

Default valid values:

• bell-na.wav

• bell-uk.wav

• buzzer.wav

• chime.wav

• dogs.wav

• gong.wav

• page-notif.wav

• tone-1kHz-max.wav

• warble1-low.wav

• warble2-med.wav

• warble3-high.wav

• warble4-trill.wav

Note: The file name of any file stored under the System → File Manager → tones folder is a valid value.

interval

When audio file looping is enabled (loop = true), specify the pause time between playbacks, in seconds.

Integer

Optional

loop

Set the tone file to loop

boolean

Required

Valid values:

• “true”

• “false”

mcast

Configure the device to multicast transmit and play a tone or loop a tone on a receiving device.

boolean

Optional

Valid values:

• “true”

• “false”

Multicast must be on to use. If multicast is turned on via /mcast/update at any time, this call will default to these settings. If multicast is only configured via the web interface, this call will default to the web interface settings.

Note: For firmware version 5.5 and earlier, this parameter is available only on 8301 devices.

playback

Whether the receiving endpoint plays the multicast message

string

Optional

Valid values:

• “true”

• “false”

Note: For firmware version 5.5 and earlier, this parameter is available only on 8301 devices.

state

The multicast parameters.

string

Optional

Note: For firmware version 5.5 and earlier, this parameter is available only on 8301 devices.

mode

The multicast mode of the device

string

Optional

Valid values:

• “sender”

address

The IP address of the multicast zone.

string

Optional

port

The port of the multicast zone.

string

Optional

type

The multicast transfer type.

string

Optional

Valid values:

• “poly”

• “rtp“

group

The Poly group being used.

integer

Optional

Valid values: numbers 1 through 25.

Applicable only when “type” is set as “poly”.

duration

How long the strobe light is on (in seconds).

Integer

Optional

This parameter is available only on firmware v5.7 and later.

pattern

The number of the pattern set.

Integer

Required

Valid values: See Algo Strobe Light Pattern Reference Guide

color1

The color to set the strobe

String

Required

Valid values:

• "red”

• "blue”

• “green”

• “amber”

color2

The second color for the strobe to use if the pattern uses two colors.

String

Optional

Only applicable to 8138/8410/8420.

Valid values:

• "red”

• "blue”

• “green”

• “amber”

ledlvl

The brightness of the strobe light.

String

Required

For 8190S:

• Low: 1

• Medium: 2

• High: 3

For 8128(G2)/8138/8410/8420:

• Low: 0

• Medium: 56

• High: 255

stopAfter

How long the image stays (in seconds).

Integer

Optional

This parameter is available only on firmware v5.7 and later.

type

The type of background to display

String

Required

Set as “image”

image1

The file name of the image

String

Required

stopAfter

How long the scrolling text stays (in seconds).

Integer

Optional

This parameter is available only on firmware v5.7 and later.

type

The type of background to display.

String

Required

Set as “image”

image1

The file name of the image.

String

Required

text1

The text to be displayed on the device.

String

Required

textColor

The color of the text.

String

Optional

Valid values:

• SVG color name

• HEX code

For example, use either of the following to set the text color as black:

"textColor": "black"
"textColor": "#000000"

For more information, see HTML Color Names.

Default= “black”

textFont

The font of the text.

String

Optional

Valid values include:

• “acumin”

• “bookman”

• “din”

• “inter”

• “nixie”

• “overpass”

• “roboto”

Default= “inter”

textPosition

Where the text should be displayed on the screen.

String

Optional

Valid values include:

• “top”

• “middle”

• “bottom”

Default= “bottom”

textScroll

Turn text scroll on or off.

String

Optional

Valid values include:

• “true”

• “false”

Default=”true”

textScrollSpeed

The speed at which the text scrolls.

String

Optional

Valid values include (in increasing speed):

• “1”

• “2”

• “3”

• “4”

• “5”

Default= “1”

textSize

The size of the text.

String

Optional

Valid string values include:

• “tiny“ (equal to integer value 60)

• “small” (equal to integer value 100)

• “medium (equal to integer value 200)

• “large” (equal to integer value 30)

Valid integer values:  50 - 300

Default=”large” (in v5.6 and earlier)

stopAfter

How long the clock stays (in seconds).

Integer

Optional

This parameter is available only on firmware v5.7 and later.

type

The type of clock to display

String

Required

Valid values:

• “digitalClock”

• “analogClock”

clockFormat

Display the time in a 12h or 24h format.

String

Optional

Use if type=digitalClock

Valid values:

• “12h”

• “24h”

Default= “24h”

clockSeconds

clockSeconds

Boolean

Optional

Use if type=digitalClock

Default= “false”

clockSecondsAnalog

Enable or disable displaying clock seconds

Boolean

Optional

Use if type= analogClock

Default= “true”

clockBgColor

The background color of the clock

String

Optional

Use if type=digitalClock

Valid values:

• SVG color name

• HEX code

clockFgColor

The foreground color of the clock

String

Optional

Use if type=digitalClock

Valid values:

• SVG color name

• HEX code

Default= “white”

analogBgColor

The background color of the clock

String

Optional

Use if type=analogClock

Valid values:

• SVG color name

• HEX code

analogFgColor

The foreground color of the clock

String

Optional

Use if type=analogClock

Valid values:

• SVG color name

• HEX code

Default= “black”

analogSecondsColor

The color of the seconds hand on the analog clock

String

Optional

Use if type=analogClock

Valid values:

• SVG color name

• HEX code

clockFont

The font of the clock text

String

Optional

Use if type=digitalClock

Valid values include:

• “acumin”,

• “bookman”,

• “din”,

• “inter”,

• “nixie”,

• “overpass”,

• “roboto”

Default= “inter”

clockBgImage

The file name of the background image to use behind the clock if needed.

String

Optional

stopAfter

How long the flashing image stays (in seconds).

Integer

Optional

This parameter is available only on firmware v5.7 and later.

type

The type of background to display

String

Required

Set as “blitz”

image1

The image file name to use

String

Required

image2

The image file name to use

String

Required

stopAfter

How long the slideshow stays (in seconds).

Integer

Optional

This parameter is available only on firmware v5.7 and later.

duration

Duration of each slide in seconds

Integer

Required

slideNames

The file names of the slides to display in the slideshow

Comma-separated values as a string

Required

Format is: “slide1, slide2, slide3, …”

overrideStrobe

Use specified strobe parameters for the slideshow instead of the strobe parameters of each individual slide.

Boolean

Required

Valid values include:

• “true”

• “false”