kitt v0.3.0 Kitt.Message.SSM View Source

Defines the structure and instantiation function for creating a J2735-compliant SignalStatusMessage

An SSM defines the message sent by DSRC-capable infrastructure to relay to vehicles the status of current signals and collection of pending or active pre-emption or requests

Link to this section Summary

Types

prioritization_response_status()

signal_requester_info()

signal_status()

signal_status_package()

t()

Defines the structure of a SignalStatusMessage and the data elements comprising its fields

Functions

Produces an SSM message struct from an equivalent map or keyword input

type()

Returns the SSM identifying atom recognized by the ASN1 spec

Returns the SSM identifying integer

Link to this section Types

prioritization_response_status()

prioritization_response_status() ::
  :unknown
  | :requested
  | :processing
  | :watchOtherTraffic
  | :granted
  | :rejected
  | :maxPresence
  | :reserviceLocked

signal_requester_info()

signal_requester_info() :: %{
  id: Kitt.Types.vehicle_id(),
  request: non_neg_integer(),
  sequenceNumber: non_neg_integer(),
  role: Kitt.Types.basic_vehicle_role(),
  typeData: Kitt.Types.requestor_type()
}

signal_status()

signal_status() :: %{
  sequenceNumber: non_neg_integer(),
  id: Kitt.Types.intersection_reference_id(),
  sigStatus: [signal_status_package()],
  regional: [Kitt.Types.regional_extension()]
}

signal_status_package()

signal_status_package() :: %{
  requester: signal_requester_info(),
  inboundOn: Kitt.Types.intersection_access_point(),
  outboundOn: Kitt.Types.intersection_access_point(),
  minute: non_neg_integer(),
  second: non_neg_integer(),
  duration: non_neg_integer(),
  status: prioritization_response_status(),
  regional: [Kitt.Types.regional_extension()]
}

t()

t() :: %Kitt.Message.SSM{
  regional: [Kitt.Types.regional_extension()],
  second: non_neg_integer(),
  sequenceNumber: non_neg_integer(),
  status: [signal_status()],
  timeStamp: Kitt.Types.minute_of_year()
}

Defines the structure of a SignalStatusMessage and the data elements comprising its fields

Link to this section Functions

new(message)

new(map() | keyword()) :: t()

Produces an SSM message struct from an equivalent map or keyword input

type()

type() :: atom()

Returns the SSM identifying atom recognized by the ASN1 spec

type_id()

type_id() :: non_neg_integer()

Returns the SSM identifying integer