kitt v0.3.0 Kitt.Message.SRM View Source

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

An SRM defines the interchange of a DSRC-capable vehicle with the infrastructure regarding signal and timing information pertaining to an intersection

Link to this section Summary

Types

requestor_description()

requestor_position_vector()

signal_request()

signal_request_package()

t()

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

transit_status()

Functions

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

type()

Returns the SRM identifying atom recognized by the ASN1 spec

Returns the SRM identifying integer

Link to this section Types

requestor_description()

requestor_description() :: %{
  id: Kitt.Types.vehicle_id(),
  type: Kitt.Types.requestor_type(),
  position: requestor_position_vector(),
  name: String.t(),
  routeName: String.t(),
  transitStatus: transit_status(),
  transitOccupancy:
    :occupancyUnknown
    | :occupancyEmpty
    | :occupancyVeryLow
    | :occupancyLow
    | :occupancyMed
    | :occupancyHigh
    | :occupancyNearlyFull
    | :occupancyFull,
  transitSchedule: integer(),
  regional: [Kitt.Types.regional_extension()]
}

requestor_position_vector()

requestor_position_vector() :: %{
  position: Kitt.Types.position_3d(),
  heading: non_neg_integer(),
  speed: Kitt.Types.transmission_and_speed()
}

signal_request()

signal_request() :: %{
  id: Kitt.Types.intersection_reference_id(),
  requestID: non_neg_integer(),
  requestType:
    :priorityRequestTypeReserved
    | :priorityRequest
    | :priorityRequestUpdate
    | :priorityCancellation,
  inBoundLane: Kitt.Types.intersection_access_point(),
  outBoundLane: Kitt.Types.intersection_access_point(),
  regional: [Kitt.Types.regional_extension()]
}

signal_request_package()

signal_request_package() :: %{
  request: signal_request(),
  minute: non_neg_integer(),
  second: non_neg_integer(),
  duration: non_neg_integer(),
  regional: [Kitt.Types.regional_extension()]
}

t()

t() :: %Kitt.Message.SRM{
  regional: [Kitt.Types.regional_extension()],
  requestor: requestor_description(),
  requests: [signal_request_package()],
  second: non_neg_integer(),
  sequenceNumber: non_neg_integer(),
  timeStamp: Kitt.Types.minute_of_year()
}

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

transit_status()

transit_status() :: :none | :anADAuse | :aBikeLoad | :doorOpen | :occM | :occL

Link to this section Functions

new(message)

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

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

type()

type() :: atom()

Returns the SRM identifying atom recognized by the ASN1 spec

type_id()

type_id() :: non_neg_integer()

Returns the SRM identifying integer