Streetlight group

An entity of type StreetlightGroup represents a group of streetlights. They might be controlled together by the same automated system (cabinet controller).

Data Model

The data model is defined as shown below:

  • id : Entity's unique identifier.

  • type : It must be equal to StreetlightGroup.

  • source : A sequence of characters giving the source of the entity data.

    • Attribute type: Text or URL
    • Optional
  • dataProvider : Specifies the URL to information about the provider of this information

    • Attribute type: URL
    • Optional
  • location : Streetlight's group location represented by a GeoJSON (multi)geometry.

  • areaServed : Higher level area to which the streetlight group belongs to. It can be used to group per responsible, district, neighbourhood, etc.

  • powerState : Streetlight group'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
  • refStreetlightControlCabinet : Streetlight group's control cabinet

  • 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
  • switchingOnHours : Switching on hours. It is used normally to set special schedules for certain dates.

    • Attribute Type: List of StructuredValue
    • Subproperties:
      • from : Starting date (it can be yearless).
      • to : Ending date (it can be yearless)
      • hours : Hours.
    • Attribute metadata:
      • timestamp : Timestamp when the last update of the attribute happened.
    • Optional
  • switchingMode : Switching mode.

    • Attribute Type: List of Text
    • Allowed values: (night-ON, night-OFF, night-LOW, always-ON, day-ON, day-OFF, day-LOW)
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional
  • illuminanceLevel : Relative illuminance level setting for the group.

    • Attribute Type: Number
    • Allowed values: A number between 0 and 1.
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional
  • activeProgramId : Identifier of the active program for this streetlight group.

    • Attribute type: Text
    • Attribute metadata:
      • timestamp: Timestamp when the last update of the attribute happened.
    • Optional
  • dateModified : Timestamp of the last update made to this entity.

    • Attribute Type: DateTime
    • Read-Only. Automatically generated.
  • description : Description about the streetlight group.

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

    • Attribute type: List of Text
    • Optional
  • refStreetlight : List of streetlight entities belonging to this group.

    • Attribute type: List of references to entities fo type Streetlight
    • Allowed values: There must topographical integrity between the location of the group and of the individual streetlights.
    • 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

Normalized Example

Normalized NGSI response

{
    "id": "streetlightgroup:mycity:A12",
    "type": "StreetlightGroup",
    "circuitId": {
        "value": "C-456-A467"
    },
    "powerState": {
        "value": "on"
    },
    "dateLastSwitchingOn": {
        "type": "DateTime",
        "value": "2016-07-07T19:59:06.618Z"
    },
    "refStreetlightCabinetController": {
        "type": "Relationship",
        "value": "cabinetcontroller:CC45A34"
    },
    "dateLastSwitchingOff": {
        "type": "DateTime",
        "value": "2016-07-07T07:59:06.618Z"
    },
    "switchingOnHours": {
        "value": [
            {
                "hours": "Mo,Su 16:00-02:00",
                "to": "--01-07",
                "from": "--11-30",
                "description": "Christmas"
            }
        ]
    },
    "location": {
        "type": "geo:json",
        "value": {
            "type": "MultiLineString",
            "coordinates": [
                [[100.0, 0.0], [101.0, 1.0]],
                [[102.0, 2.0], [103.0, 3.0]]
            ]
        }
    },
    "areaServed": {
        "value": "Calle Comercial Centro"
    }
}

key-value pairs Example

Sample uses simplified representation for data consumers ?options=keyValues

{
    "id": "streetlightgroup:mycity:A12",
    "type": "StreetlightGroup",
    "location": {
        "type": "MultiLineString",
        "coordinates": [
            [[100.0, 0.0], [101.0, 1.0]],
            [[102.0, 2.0], [103.0, 3.0]]
        ]
    },
    "powerState": "on",
    "areaServed": "Calle Comercial Centro",
    "circuitId": "C-456-A467",
    "dateLastSwitchingOn": "2016-07-07T19:59:06.618Z",
    "dateLastSwitchingOff": "2016-07-07T07:59:06.618Z",
    "refStreetlightCabinetController": "cabinetcontroller:CC45A34",
    "switchingOnHours": [
        {
            "from": "--11-30",
            "to": "--01-07",
            "hours": "Mo,Su 16:00-02:00",
            "description": "Christmas"
        }
    ]
}

Test it with a real service

Open Issues

  • Do we really need metering attributes on this entity? Is metering only going to be done at Cabinet level?