Streetlight

An entity of type Streetlight represents a urban streetlight. Actually, there will be an entity of type Streetlight per lamp. Thus, if a particular pole holds more than one lantern there will be as many streetlight entites as installed lamps. As a result there might be more than one streetlight entity per location. A Steeetlight entity does not contain any attribute corresponding to structural characteristics. Such data is captured by entities of type StreetlightModel.

Data Model

The data model is defined as shown below:

  • id : Entity's unique identifier.

  • type : It must be equal to Streetlight.

  • location : Streetlight's location represented by a GeoJSON Point.

  • address : Civic address where the streetlight is located.

  • areaServed : Higher level area to which this streetlight belongs to. It can be used to group streetlights per responsible, district, neighbourhood, etc. + Attribute type: Text + Optional

  • circuit : The circuit to which this streetlight connects to and gets power from. Typically it will contain an identifier that will allow to obtain more information about such circuit. + Attribute type: Text + Optional

  • refStreetlightModel : Streetlight's model.

  • refStreetlightControlCabinet : If this streetlight is individually controlled, reference to the control cabinet in charge of.

  • status : The overall status of this street light.

    • Attribute type: Text
    • Allowed values: one Of (ok, defectiveLamp, columnIssue, brokenLantern)
      • Or any other value meaningful to the application and not covered by the values above.
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Mandatory
  • powerState : Streetlight's power state.

    • Attribute type: Text
    • Attribute metadata:
      • timestamp : Timestamp when the last update of the attribute happened.
    • Allowed values: one Of (on, off, low, bootingUp)
    • Optional
  • refDevice : Reference to the device(s) used to monitor this streetligth.

    • Attribute type: List of Reference to entity(ies) of type Device
    • Optional
  • refStreetlightGroup : Streetlight's group, if this streetlight belongs to any group.

  • dateLastLampChange : Timestamp of the last change of lamp made. If null it will mean that the lamp has never been changed.

    • Attribute Type: DateTime
    • Attribute metadata:
      • timestamp : Timestamp when the last update of the attribute happened.
    • Optional
  • dateLastSwitchingOn : Timestamp of the last switching on.

    • Attribute Type: DateTime
    • Attribute metadata:
      • timestamp : Timestamp when the last update of the attribute happened.
    • Optional
  • dateLastSwitchingOff : Timestamp of the last switching off.

    • Attribute Type: DateTime
    • Attribute metadata:
      • timestamp : Timestamp when the last update of the attribute happened.
    • Optional
  • controllingMethod : The method used to control this streetlight.

    • Attribute type: Text
    • Allowed values: one Of (group, individual)
    • Optional
  • dateModified : Timestamp of the last update made to this entity

    • Attribute Type: DateTime
    • Read-Only. Automatically generated.
  • dateServiceStarted : Date at which the streetlight started giving service.

    • Attribute Type: Date
    • Optional
  • image : A URL containing a photo of the streetlight.

  • description : Description about the streetlight.

  • annotations : A field reserved for annotations (incidences, remarks, etc.).

    • Attribute type: List of Text
    • Optional
  • locationCategory : Category of the location where the streetlight is placed.

    • Attribute type:
    • Allowed values: oneOf (fa├žade, sidewalk, pedestrianPath, road, playground, park, garden, bridge, tunnel, parking, centralIsland) + Or any other value with semantics not covered by the above list.
  • lanternHeight : Lantern's height. In columns with many arms this can vary between streetlights. Another variation source of this property are wall-mounted streetlights. + Attribute type: Number + Default unit: Meters. + Optional

  • illuminanceLevel : Relative illuminance level setting.

    • Attribute Type: Number
    • Allowed values: A number between 0 and 1.
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional

Note: JSON Schemas only capture the NGSI simplified representation, this means that to test the JSON schema examples with a FIWARE NGSI version 2 API implementation, you need to use the keyValues mode (options=keyValues).

Examples of Use

{
  "id": "streetlight:guadalajara:4567",
  "type": "Streetlight",
  "location": {
    "type": "Point",
    "coordinates": [  -3.164485591715449, 40.62785133667262 ]
  },
  "areaServed": "Roundabouts city entrance",
  "status": "ok",
  "refStreetlightGroup": "streetlightgroup:G345",
  "refStreetlightModel": "streetlightmodel:STEEL_Tubular_10m",
  "circuit": "C-456-A467",
  "lanternHeight": 10,
  "locationCategory" : "centralIsland",
  "powerState": "off",
  "controllingMethod": "individual",
  "dateLastLampChange": "2016-07-08T08:02:21.753Z"
}

Test it with a real service

Open Issues

  • Initially is not considered practical to monitor individual power consumptions