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     }
  41
  42     optional Type type = 1;
  43     optional DiagnosticControlCommand diagnostic_request = 2;
  44     optional PassthroughModeControlCommand passthrough_mode_request = 3;
  45     optional AcceptanceFilterBypassCommand acceptance_filter_bypass_command = 4;
  46     optional PayloadFormatCommand payload_format_command = 5;
  47     optional PredefinedObd2RequestsCommand predefined_obd2_requests_command = 6;
  48         optional ModemConfigurationCommand modem_configuration_command = 7;
  49 }
  50
  51 message DiagnosticControlCommand {
  52     enum Action { ADD = 1; CANCEL = 2; }
  53
  54     optional DiagnosticRequest request = 1;
  55     optional Action action = 2;
  56 }
  57
  58 message PassthroughModeControlCommand {
  59     optional int32 bus = 1;
  60     optional bool enabled = 2;
  61 }
  62
  63 message AcceptanceFilterBypassCommand {
  64     optional int32 bus = 1;
  65     optional bool bypass = 2;
  66 }
  67
  68 message PayloadFormatCommand {
  69     enum PayloadFormat {
  70         JSON = 1;
  71         PROTOBUF = 2;
  72     }
  73
  74     optional PayloadFormat format = 1;
  75 }
  76
  77 message PredefinedObd2RequestsCommand {
  78     optional bool enabled = 1;
  79 }
  80
  81 message NetworkOperatorSettings {
  82         enum OperatorSelectMode {
  83                 AUTOMATIC = 0;
  84                 MANUAL = 1;
  85                 DEREGISTER = 2;
  86                 SET_ONLY = 3;
  87                 MANUAL_AUTOMATIC = 4;
  88         }
  89         message NetworkDescriptor {
  90                 enum NetworkType {
  91                         GSM = 0;
  92                         UTRAN = 2;
  93                 }
  94                 optional uint32 PLMN = 1;
  95                 optional NetworkType networkType = 2;
  96         }
  97         optional bool allowDataRoaming = 1;
  98         optional OperatorSelectMode operatorSelectMode = 2;
  99         optional NetworkDescriptor networkDescriptor = 3;
 100 }
 101
 102 message NetworkDataSettings {
 103         optional string APN = 1;
 104 }
 105
 106 message ServerConnectSettings {
 107         optional string host = 1;
 108         optional uint32 port = 2;
 109 }
 110
 111 message ModemConfigurationCommand {
 112         optional NetworkOperatorSettings networkOperatorSettings = 1;
 113         optional NetworkDataSettings networkDataSettings = 2;
 114         optional ServerConnectSettings serverConnectSettings = 3;
 115 }
 116
 117 message CommandResponse {
 118     optional ControlCommand.Type type = 1;
 119     optional string message = 2;
 120     optional bool status = 3;
 121 }
 122
 123 message DiagnosticRequest {
 124     enum DecodedType { NONE = 1; OBD2 = 2; }
 125
 126     optional int32 bus = 1;
 127     optional uint32 message_id = 2;
 128     optional uint32 mode = 3;
 129     optional uint32 pid = 4;
 130     // TODO we are capping this at 8 bytes for now - need to change when we
 131     // support multi-frame responses
 132     optional bytes payload = 5;
 133     optional bool multiple_responses = 6;
 134     optional double frequency = 7;
 135     optional string name = 8;
 136     optional DecodedType decoded_type = 9;
 137 }
 138
 139 message DiagnosticResponse {
 140     optional int32 bus = 1;
 141     optional uint32 message_id = 2;
 142     optional uint32 mode = 3;
 143     optional uint32 pid = 4;
 144     optional bool success = 5;
 145     optional uint32 negative_response_code = 6;
 146     // TODO we are capping this at 8 bytes for now - need to change when we
 147     // support multi-frame responses
 148     optional bytes payload = 7;
 149     optional double value = 8;
 150 }
 151
 152 message DynamicField {
 153     enum Type { STRING = 1; NUM = 2; BOOL = 3; }
 154
 155     optional Type type = 1;
 156     optional string string_value = 2;
 157     optional double numeric_value = 3;
 158     optional bool boolean_value = 4;
 159 }
 160
 161 message SimpleMessage {
 162     optional string name = 1;
 163     optional DynamicField value = 2;
 164     optional DynamicField event = 3;
 165 }