Kitt.Message.SSM (kitt v0.4.0) 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

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

Returns the SSM identifying atom recognized by the ASN1 spec

Returns the SSM identifying integer

Link to this section Types

Link to this type

prioritization_response_status()

View Source

Specs

prioritization_response_status() ::
  :unknown
  | :requested
  | :processing
  | :watchOtherTraffic
  | :granted
  | :rejected
  | :maxPresence
  | :reserviceLocked
Link to this type

signal_requester_info()

View Source

Specs

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()
}

Specs

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

signal_status_package()

View Source

Specs

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()]
}

Specs

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

Specs

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

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

Specs

type() :: atom()

Returns the SSM identifying atom recognized by the ASN1 spec

Specs

type_id() :: non_neg_integer()

Returns the SSM identifying integer