Data

Traffic light controller Item

Traffic Controller Item represents traffic light controller. The Item must have class set to TrafficLightController and type to Device.

Metadata

{
  "plans": [{
    "no": 1,
    "name": "VA",
    "description": "Adaptive"
  }, {
    "no": 2,
    "name": "VA2",
    "description": "Fixed"
  }],
  "signalGroups": [{
    "no": 1,
    "name": "VA"
  }, {
    "no": 2,
    "name": "VA2"
  }],
  "detectors": [{
    "no": 1,
    "name": "DVA_1"
  }, {
    "no": 2,
    "name": "DVA_2"
  }]
}

Where:

• plans List of plans
• plans.no Plan number
• plans.name Plan name
• plans.description Plan description
• signalGroups List of signal groups
• signalGroups.no Signal group number
• signalGroups.name Signal group name
• detectors List of detectors
• detectors.no Detector number
• detectors.name Detector name

Commands

All following commands are module-specific and are published via Webhooks to all registered subscribers.

TrafficControlerControlCommand

Command with type TrafficControlerControlCommand is dedicated to switch operating state or plan of traffic controller.

Command extras

{
  "cancelationToken": "507f1f77bcf86cd799439578",
  "controllerOperatingState": "On",
  "planNo": "1",
  "from": "2016-09-25T00:00:00.000Z",
  "to": "2016-09-25T10:00:00.000Z",
  "priority": 5
}

• cancelationToken Token for command cancelation
• controllerOperatingState Controller operating state On, Default, FlashingYellowYield, Dark or FlashingYellow )
• planNo Plan number (controllerOperatingState must be set to On)
• from Start time
• to Finish time
• priority Priority number (higher number means higher priority)

TrafficControlerCancelControlCommand

Command with type TrafficControlerCancelControlCommand is dedicated to cancel an existing TrafficControlerControlCommand.

Command extras

{
  "cancelationToken": "507f1f77bcf86cd799439578"
}

• cancelationToken Token for command cancelation

Events

All following events are module-specific.

ControllerStateChangedEvent

Event ControllerStateChangedEvent informs about change of controller's operating state.

Event extras

{
  "localSchedule": false,
  "controllerOperatingState": "On",
  "plan": {
    "no": "1",
    "name": "VA"
  }
}

• localSchedule Is used local scheduler stored in controller.
• controllerOperatingState Controller operating state (On, FlashingYellowYield, Dark, FlashingYellow)
• plan.No Plan number
• plan.Name Plan name

ControllerStateEvent

Event ControllerStateEvent informs about detailed controller's operating state including informations about detectors status and signal groups status. This event is registered for everyone second frame (TX).

Event extras

{  
  "localSchedule": false,
  "controllerOperatingState": "On",
  "plan": {
    "no": "1",
    "name": "VA"
  },
  "tx": 12,
  "signalGroupsState": [{
    "no": 1,
    "name": "VA",
    "state": "Red"
  }],
  "detectorsState": [{
    "no": 1,
    "name": "DVA_1",
    "state": "Ok",
    "occupancies": [{
      "offset": 0,
      "occupied": true
    }, {
      "offset": 100,
      "occupied": false
    }]
  }]
}

• localSchedule Is used local scheduler stored in controller.
• controllerOperatingState Controller operating's state ( On, FlashingYellowYield, Dark, FlashingYellow)
• plan.No Plan number
• plan.Name Plan name
• tx Traffic's second
• signalGroupsState List of signal groups
• signalGroupsState.no Signal group number
• signalGroupsState.name Signal group name
• signalGroupsState.state Signal group state (Dark, Red, Yellow, Green, RedYellow, YellowGreen)
• detectorsState List of detectors
• detectorsState.no Detectors number
• detectorsState.name Detector name
• detectorsState.state Detector state (Ok, Inactive, Failed)
• detectorsState.occupancies List of detector occupancies
• detectorsState.occupancies.offset Offset describes in what millisecond from TX occupancy has been changed.
• detectorsState.occupancy.occupied Detector occupation status

R09TelegramReceivedEvent

Event R09TelegramReceivedEvent informs that R09 telegram from public transport vehicle has been received.

Event extras

{
  "detectionPoint": 1578945,
  "line": "1287",
  "route": 45,
  "directionNumber": 13,
  "deviation": 7,
  "priority": 0,
  "vehicleId": "123456",
  "vehicleType": "Bus",
  "vehicleLength": 2
}

• detectionPointDetection point number
• line Line number
• route Route number
• directionNumber Direction number
• deviation Deviation from the timetable (in minutes, positive value means delay versus timetable)
• priority Priority 0 - 3 (0=none, 3=top priority)
• vehicleId Vehicle number
• vehicleType Vehicle type (Bus, Tram, Train, Metro or Trolleybus)
• vehicleLength Public transport vehicle length in tens of meters

ControllerMessageEvent

Event ControllerMessageEvent informs that log message has been received.

Event extras

{
  "category": "Operating status",
  "severity": "Information",
  "message": "The plan has been switched to P3",
  "flag": false
}

• category Message category
• severity Message severity (Information, Warning, Error, Fatal)
• message Text message
• flag Flagged or not