openxc.proto

   1 package openxc;
   2
   3 option java_package = "com.openxc";
   4 option java_outer_classname = "BinaryMessages";
   5
   6 message VehicleMessage {
   7     enum Type { CAN = 1; SIMPLE = 2; DIAGNOSTIC = 3; CONTROL_COMMAND = 4;
   8             COMMAND_RESPONSE = 5; }
   9
  10     optional Type type = 1;
  11     optional CanMessage can_message = 2;
  12     optional SimpleMessage simple_message = 3;
  13     optional DiagnosticResponse diagnostic_response = 4;
  14     optional ControlCommand control_command = 5;
  15     optional CommandResponse command_response = 6;
  16         optional uint32 uptime = 7;
  17 }
  18
  19 message CanMessage {
  20     enum FrameFormat {
  21         STANDARD = 1;
  22         EXTENDED = 2;
  23     }
  24     optional int32 bus = 1;
  25     optional uint32 id = 2;
  26     optional bytes data = 3;
  27     optional FrameFormat frame_format = 4;
  28 }
  29
  30 message ControlCommand {
  31     enum Type {
  32         VERSION = 1;
  33         DEVICE_ID = 2;
  34         DIAGNOSTIC = 3;
  35         PASSTHROUGH = 4;
  36         ACCEPTANCE_FILTER_BYPASS = 5;
  37         PAYLOAD_FORMAT = 6;
  38         PREDEFINED_OBD2_REQUESTS = 7;
  39                 MODEM_CONFIGURATION = 8;
  40                 RTC_CONFIGURATION = 9;
  41     }
  42
  43     optional Type type = 1;
  44     optional DiagnosticControlCommand diagnostic_request = 2;
  45     optional PassthroughModeControlCommand passthrough_mode_request = 3;
  46     optional AcceptanceFilterBypassCommand acceptance_filter_bypass_command = 4;
  47     optional PayloadFormatCommand payload_format_command = 5;
  48     optional PredefinedObd2RequestsCommand predefined_obd2_requests_command = 6;
  49         optional ModemConfigurationCommand modem_configuration_command = 7;
  50         optional RTCConfigurationCommand rtc_configuration_command = 8;
  51 }
  52
  53 message DiagnosticControlCommand {
  54     enum Action { ADD = 1; CANCEL = 2; }
  55
  56     optional DiagnosticRequest request = 1;
  57     optional Action action = 2;
  58 }
  59
  60 message PassthroughModeControlCommand {
  61     optional int32 bus = 1;
  62     optional bool enabled = 2;
  63 }
  64
  65 message AcceptanceFilterBypassCommand {
  66     optional int32 bus = 1;
  67     optional bool bypass = 2;
  68 }
  69
  70 message PayloadFormatCommand {
  71     enum PayloadFormat {
  72         JSON = 1;
  73         PROTOBUF = 2;
  74                 MESSAGEPACK = 3;
  75     }
  76
  77     optional PayloadFormat format = 1;
  78 }
  79
  80 message PredefinedObd2RequestsCommand {
  81     optional bool enabled = 1;
  82 }
  83
  84 message NetworkOperatorSettings {
  85         enum OperatorSelectMode {
  86                 AUTOMATIC = 0;
  87                 MANUAL = 1;
  88                 DEREGISTER = 2;
  89                 SET_ONLY = 3;
  90                 MANUAL_AUTOMATIC = 4;
  91         }
  92         message NetworkDescriptor {
  93                 enum NetworkType {
  94                         GSM = 0;
  95                         UTRAN = 2;
  96                 }
  97                 optional uint32 PLMN = 1;
  98                 optional NetworkType networkType = 2;
  99         }
 100         optional bool allowDataRoaming = 1;
 101         optional OperatorSelectMode operatorSelectMode = 2;
 102         optional NetworkDescriptor networkDescriptor = 3;
 103 }
 104
 105 message NetworkDataSettings {
 106         optional string APN = 1;
 107 }
 108
 109 message ServerConnectSettings {
 110         optional string host = 1;
 111         optional uint32 port = 2;
 112 }
 113
 114 message ModemConfigurationCommand {
 115         optional NetworkOperatorSettings networkOperatorSettings = 1;
 116         optional NetworkDataSettings networkDataSettings = 2;
 117         optional ServerConnectSettings serverConnectSettings = 3;
 118 }
 119
 120 message RTCConfigurationCommand {
 121         optional uint32 unix_time = 1;
 122 }
 123
 124 message CommandResponse {
 125     optional ControlCommand.Type type = 1;
 126     optional string message = 2;
 127     optional bool status = 3;
 128 }
 129
 130 message DiagnosticRequest {
 131     enum DecodedType { NONE = 1; OBD2 = 2; }
 132
 133     optional int32 bus = 1;
 134     optional uint32 message_id = 2;
 135     optional uint32 mode = 3;
 136     optional uint32 pid = 4;
 137     // TODO we are capping this at 8 bytes for now - need to change when we
 138     // support multi-frame responses
 139     optional bytes payload = 5;
 140     optional bool multiple_responses = 6;
 141     optional double frequency = 7;
 142     optional string name = 8;
 143     optional DecodedType decoded_type = 9;
 144 }
 145
 146 message DiagnosticResponse {
 147     optional int32 bus = 1;
 148     optional uint32 message_id = 2;
 149     optional uint32 mode = 3;
 150     optional uint32 pid = 4;
 151     optional bool success = 5;
 152     optional uint32 negative_response_code = 6;
 153     // TODO we are capping this at 8 bytes for now - need to change when we
 154     // support multi-frame responses
 155     optional bytes payload = 7;
 156     optional double value = 8;
 157 }
 158
 159 message DynamicField {
 160     enum Type { STRING = 1; NUM = 2; BOOL = 3; }
 161
 162     optional Type type = 1;
 163     optional string string_value = 2;
 164     optional double numeric_value = 3;
 165     optional bool boolean_value = 4;
 166 }
 167
 168 message SimpleMessage {
 169     optional string name = 1;
 170     optional DynamicField value = 2;
 171     optional DynamicField event = 3;
 172 }