Page tree
Skip to end of metadata
Go to start of metadata

The location object provides detailed information regarding the location of an item, such as an edge server or edge device.   This object is used as part of the Segment Configuration object or Device Configuration object.

Example

{   /* location of an edge server*/
   desc: "cab 23/N4",
   lat: 51.5059,
   lng: -0.33302
}

Properties

The location object contains the following properties:

Field Name

Type

Description

column

number

(Optional) Used with row. The row/column pair of numbers acts as a location identifier that can be used for two-dimensional prediction of motion, sometimes referred to as “direction of travel.”

Valid column numbers range from 0 to 255.

These coordinates are not normally used with edge servers or other infrastructure devices, but can be used to manage motion prediction for edge devices. 

desc

string

(Optional) Human-readable alphanumeric location description.

Example: "cab 23/N4" or "pole 23S"

ele

number

(Optional) Elevation above NN (Normal-Null), in meters.

lat

number

(Optional) Latitude of the edge server (used with lng).

lat (latitude) and lng (longitude) must be provided to the edge server if schedules use sunset or sunrise. Use an approximate location if the exact edge server coordinates are unknown.  

The scheduler uses the edge server's location for sunset or sunrise calculations. It assumes that all edge devices that are managed by the same edge server are located in the same vicinity. 

lng

number

(Optional) Longitude of the edge server (used with lat). See lat description above for more information.

row

number

(Optional) Used with column. Valid row numbers range from 0 to 255. See column description above for more information.

sunrise

number

(Optional) Provides the sunrise elevation angle offset. This number is provided in degrees > 0, for the elevation above the horizon, and in degrees < 0 for elevation below the horizon.

Usage example: An edge server might compute the time of sunset or sunrise to be the transition of the sun at the horizon, which marks the transition between astronomical day and civil twilight. An elevation angle of -6° shifts the time of sunset and sunrise to the transition between civil twilight and nautical twilight, which can amount to substantial energy savings in outdoor lighting systems, subject to their latitude, because civil twilight is generally considered bright enough not to require artificial lighting.

A positive elevation angle for sunset of +20°, for example, can help compensate for obstructions such as a mountain range to the east of the installation.

Note: lat (latitude) and lng (longitude) must be provided if schedules use sunset or sunrise. Use an approximate location if the exact edge server coordinates are unknown.

sunset

number

(Optional) Provides the sunset elevation angle offset. This number is provided in degrees > 0, for the elevation above the horizon, and in degrees < 0 for elevation below the horizon. See "Sunrise" description, above for more information.





  • No labels