Protocol Documentation#

Table of Contents#

Protos/system_monitor_common.proto
Protos/system_monitor_logging.proto
Protos/system_monitor_parameter.proto
Protos/system_monitor_project.proto
Protos/system_monitor_system.proto
Protos/system_monitor_virtual.proto
Scalar Value Types

Protos/system_monitor_common.proto#

AppParametersFileRequest#

Field	Type	Label
app_id	uint32
parameter_ids	string	repeated
file_path	string

AppParametersRequest#

Field	Type	Label	Description
app_id	uint32
parameter_ids	string	repeated

AppRequest#

Field	Type	Label	Description
app_id	uint32

ConversionRequest#

Field	Type	Label	Description
app_id	uint32
conversion_id	string

FileRequest#

Field	Type	Label	Description
file_path	string

ParameterRequest#

Field	Type	Label	Description
app_id	uint32
parameter_id	string

ParametersFileRequest#

Field	Type	Label	Description
parameter_ids	string	repeated
file_path	string

ParametersRequest#

Field	Type	Label	Description
parameter_ids	string	repeated

Return#

Field	Type	Label	Description
return_code	ErrorCode

BufferType#

Name	Number	Description
unit_buffer	0
edit_buffer	1
unit_and_edit_buffer	2

ByteOrder#

Name	Number	Description
msb_first	0
msb_last	1

ConversionType#

Name	Number	Description
rational	0
table	1
text	2
formula	3

DataType#

Name	Number	Description
ubyte	0
byte	1
uword	2
word	3
ulong	4
long	5
float	6
unknown	7
qword	8
sqword	9
double	10

ErrorCode#

Name	Number	Description
no_error	0
no_project	-1
no_licence	-2
non_specific	-3
data_version_mismatch	-4
no_data_version	-5
no_program_version	-6
no_ECU	-7
invalid_file	-8
no_appliction	-9
application_inactive	-10
live_updates_on	-11
TAGtronic_onlu	-12
SM_busy	-13
message_argument_mismatch	-20
message_dimension_mismatch	-21
message_lower_bound_non_zero	-22
bounds_error	-23
message_argument_error	-24
message_argument_invalid	-25
fdl_not_parsed	-26
conversion_invalid	-27
parameter_invalid	-28
parameter_override_not_allowed	-29
bad_state	-30
invalid_command	-31
no_data_present	-32
bad_memory_allocation	-33
partially_complete	-34
document_full	-35
parameter_identifier_already_exists	-36
parameter_read_only	-37
parameter_non_live_tuneable	-38
group_not_found	-39
file_requires_saving	-40
frequency_overridden	-41
no_customer_base	-42
parameter_not_found	-100
error_read_only	-101
error_limits	-102
error_monotony	-103
error_axis_pt	-104
error_address	-105
error_non_num	-106
error_size	-107
error_live_tune	-108
error_intp	-109
error_activelayer	-110
error_tolerance	-111
error_axis_change	-112
error_no_live_tune	-113
error_validation	-114
error_live_tune_data_invalid	-115
error_serial_not_found	-116
error_unknown	-117
error_cancel	-118
error_locked_param	-119
error_value_not_matching_entry	-120
detail_unknown	-200
dump_row_data_failed	-201
live_update_failed	-300
online_failed	-301
download_data_failed	-302
system_not_runnning	-303
parameter_locked	-304
comms_base	-1000

ErrorStatus#

Name	Number	Description
status_unknown	0
status_curent	1
status_logged	2

EventPriority#

Name	Number	Description
event_high	0
event_medium	1
event_low	2
event_debug	3

FileType#

Name	Number	Description
Project	0
PGV	1
DTV	2
desktop	3
logging_cofig	4
virtuals	5
CAN	6
live_logging	7
pot_board	8

LoggingType#

Name	Number	Description
frequency	0
cylinder	1
cycle	2
unknown_logging	3
edge	4

ParameterType#

Name	Number	Description
undefined	0
scalar	1
axis_1	2
axis_2	4
array	16
string	32
ecu	128
can	256
tsb	512
virtual	1024
axis	196608
input	268435456
measurement	268437376

Reason#

Name	Number	Description
none	0
absent	1
different	2
equal	4
different_value	8
different_size	16
different_conv	32
different_units	64
different_type	128
different_comment	256
different_def_value	512
absent_master	1024
locked	268435456

TriggerOperator#

Name	Number	Description
equals	0
less_than	1
greater_than	2
not_equal_to	3
greater_than_or_equal	4
less_than_or_equal	5

TriggerType#

Name	Number	Description
on_data	0
driver_push	1
ignition_on	2
lap_trigger	3
no_condition	4
external_trigger	5

Top

Protos/system_monitor_logging.proto#

AddParameterRequest#

Field	Type	Label
app_id	uint32
parameter_id	string
logging_rate	LoggingChannelValue	repeated

AddVirtualParameterRequest#

Field	Type	Label	Description
parameter_id	string
logging_rate	LoggingChannelValue	repeated

ChannelProperties#

Field	Type	Label	Description
index	uint32
name	string
log_logging	bool
log_telemetry	bool
logging_rate	double
telemetry_rate	double
trigger_rearm	bool
slot	uint32

ChannelPropertiesReply#

Field	Type	Label	Description
channels	ChannelProperties	repeated
return_code	system_monitor_common.ErrorCode

ChannelRequest#

Field	Type	Label	Description
index	uint32
name	string
log_to_unit	bool
log_telemetry	bool
trigger_rearm	bool

ClearRequest#

Field	Type	Label	Description
remove_triggers	bool

ConfigReply#

Field	Type	Label	Description
config_name	string
return_code	system_monitor_common.ErrorCode

DownloadProgressReply#

Field	Type	Label	Description
in_progress	bool
return_code	system_monitor_common.ErrorCode

DownloadReply#

Field	Type	Label	Description
optional_value	string
return_code	system_monitor_common.ErrorCode

DownloadRequest#

Field	Type	Label	Description
optional_app_id	uint32
optional_parameter_id	string
optional_delay_ms	uint32

GetSessionDetailReply#

Field	Type	Label	Description
name	string
value	string
return_code	system_monitor_common.ErrorCode

GetSessionDetailRequest#

Field	Type	Label	Description
name	string

LoggingChannelValue#

Field	Type	Label	Description
channel_id	uint32
type	system_monitor_common.LoggingType
value	uint32

LoggingDurationReply#

Field	Type	Label	Description
estimated_time	google.protobuf.Duration
estimated_laps	double
return_code	system_monitor_common.ErrorCode

LoggingOffsetReply#

Field	Type	Label	Description
offset	uint32
return_code	system_monitor_common.ErrorCode

LoggingOffsetRequest#

Field	Type	Label	Description
offset	uint32

LoggingParameter#

Field	Type	Label
app_id	uint32
parameter_id	string
parameter_name	string
parameter_description	string
data_size	uint32
values	LoggingChannelValue	repeated
slot	uint32

LoggingParametersReply#

Field	Type	Label
parameters	LoggingParameter	repeated
channel_names	string	repeated
return_code	system_monitor_common.ErrorCode

SetSessionDetailRequest#

Field	Type	Label	Description
name	string
value	string

SlotCountReply#

Field	Type	Label	Description
slot_count	uint32
return_code	system_monitor_common.ErrorCode

SlotPercentageReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
slot_percentage	double
return_code	system_monitor_common.ErrorCode

Trigger#

Field	Type	Label
index	uint32
start_conditions	TriggerCondition	repeated
stop_conditions	TriggerCondition	repeated
start_post_trigger	int32
stop_post_trigger	int32
slot	uint32

TriggerCondition#

Field	Type	Label	Description
index	uint32
type	system_monitor_common.TriggerType
parameter_id	string
app_id	uint32
operator	system_monitor_common.TriggerOperator
threshold	double
repeat_count	uint32

TriggerRequest#

Field	Type	Label
index	uint32
start_conditions	TriggerCondition	repeated
stop_conditions	TriggerCondition	repeated
start_post_trigger	int32
stop_post_trigger	int32

TriggersReply#

Field	Type	Label	Description
triggers	Trigger	repeated
return_code	system_monitor_common.ErrorCode

WrapReply#

Field	Type	Label	Description
wrap	bool
return_code	system_monitor_common.ErrorCode

WrapRequest#

Field	Type	Label	Description
wrap	bool

SystemMonitorLogging#

Method Name	Request Type	Response Type
GetLoggingChannelProperties	.google.protobuf.Empty	ChannelPropertiesReply
SetLoggingChannelProperties	ChannelRequest	.system_monitor_common.Return
GetLoggingTriggers	.google.protobuf.Empty	TriggersReply
SetLoggingTrigger	TriggerRequest	.system_monitor_common.Return
GetLoggingWrap	.google.protobuf.Empty	WrapReply
SetLoggingWrap	WrapRequest	.system_monitor_common.Return
GetLoggingOffset	.google.protobuf.Empty	LoggingOffsetReply
SetLoggingOffset	LoggingOffsetRequest	.system_monitor_common.Return
GetLoggingSessionDetails	GetSessionDetailRequest	GetSessionDetailReply
SetLoggingSessionDetails	SetSessionDetailRequest	.system_monitor_common.Return
GetLoggingDuration	.google.protobuf.Empty	LoggingDurationReply
GetLoggingParameterDetails	.google.protobuf.Empty	LoggingParametersReply
LoggingConfigDownloadInProgress	.google.protobuf.Empty	DownloadProgressReply
LoggingConfigDownload	DownloadRequest	DownloadReply
LoggingConfigUpload	.google.protobuf.Empty	.system_monitor_common.Return
RemoveLoggingParameter	.system_monitor_common.ParameterRequest	.system_monitor_common.Return
ClearAllLoggingParameters	ClearRequest	.system_monitor_common.Return
GetLoggingSlotsUsed	.google.protobuf.Empty	SlotCountReply
GetLoggingSlotPercentage	.system_monitor_common.ParameterRequest	SlotPercentageReply
GetECULoggingConfig	.google.protobuf.Empty	ConfigReply
AddLoggingParameter	AddParameterRequest	.system_monitor_common.Return
AddVirtualLoggingParameter	AddVirtualParameterRequest	.system_monitor_common.Return

Top

Protos/system_monitor_parameter.proto#

AddressReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
address	uint32
ident	uint32
return_code	system_monitor_common.ErrorCode

AppArray1dParameterValuesRequest#

Field	Type	Label	Description
app_id	uint32
parameters	Array1dParameterSetValue	repeated

AppArray2dParameterValuesRequest#

Field	Type	Label	Description
app_id	uint32
parameters	Array2dParameterSetValue	repeated

AppParameterValuesRequest#

Field	Type	Label	Description
app_id	uint32
parameters	ParameterSetValue	repeated

AppStringParameterValuesRequest#

Field	Type	Label	Description
app_id	uint32
parameters	StringParameterSetValue	repeated

AppTypeRequest#

Field	Type	Label	Description
app_id	uint32
data_type	system_monitor_common.ParameterType		Optional: Use ParameterType.Undefined for ALL

Array1dParameterErrorsReply#

Field	Type	Label	Description
parameters	Array1dParameterValue	repeated
return_code	system_monitor_common.ErrorCode

Array1dParameterSetValue#

Field	Type	Label	Description
parameter_id	string
values	double	repeated

Array1dParameterValue#

Field	Type	Label
parameter_id	string
values	double	repeated
return_code	system_monitor_common.ErrorCode

Array1dValueReply#

Field	Type	Label	Description
values	Array1dValues	repeated
return_code	system_monitor_common.ErrorCode

Array1dValues#

Field	Type	Label
parameter_id	string
values	double	repeated
return_code	system_monitor_common.ErrorCode

Array2dParameterErrorsReply#

Field	Type	Label	Description
parameters	Array2dParameterValue	repeated
return_code	system_monitor_common.ErrorCode

Array2dParameterSetValue#

Field	Type	Label	Description
parameter_id	string
rows	RowValues	repeated

Array2dParameterValue#

Field	Type	Label
parameter_id	string
rows	RowValues	repeated
return_code	system_monitor_common.ErrorCode

Array2dValueReply#

Field	Type	Label	Description
values	Array2dValues	repeated
return_code	system_monitor_common.ErrorCode

Array2dValues#

Field	Type	Label
parameter_id	string
rows	RowValues	repeated
return_code	system_monitor_common.ErrorCode

AxisParametersReply#

Field	Type	Label	Description
parameter_ids	string	repeated
return_code	system_monitor_common.ErrorCode

BitMaskReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
mask	int32
return_code	system_monitor_common.ErrorCode

BitShiftReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
shift	int32
return_code	system_monitor_common.ErrorCode

ByteOrderReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
byte_order	system_monitor_common.ByteOrder
return_code	system_monitor_common.ErrorCode

CANParameterProperties#

Field	Type	Label	Description
Id	string
name	string
description	string
lower_display_limit	double
upper_display_limit	double
min_logging_rate	uint32
scaling_factor	uint32
min_not_defined	bool
conversion_id	string
rx	bool
data_type	system_monitor_common.DataType
can_bus	string
can_message	string
can_start_bit	uint32
can_bit_length	uint32
can_gain	double
can_offset	double
can_mux_id	string
can_byte_order	system_monitor_common.ByteOrder
return_code	system_monitor_common.ErrorCode

CANParameterPropertiesReply#

Field	Type	Label	Description
parameters	CANParameterProperties	repeated
return_code	system_monitor_common.ErrorCode

Conversion#

Field	Type	Label	Description
id	string
type	system_monitor_common.ConversionType

ConversionListReply#

Field	Type	Label	Description
conversions	Conversion	repeated
return_code	system_monitor_common.ErrorCode

ConversionNoAppRequest#

Field	Type	Label	Description
conversion_id	string

ConversionTypeReply#

Field	Type	Label	Description
conversion_id	string
type	system_monitor_common.ConversionType
return_code	system_monitor_common.ErrorCode

ExternalParameterRequest#

Field	Type	Label	Description
parameter_id	string

ExternalReply#

Field	Type	Label	Description
parameter_id	string
gain	double
offset	double
return_code	system_monitor_common.ErrorCode

ExternalRequest#

Field	Type	Label	Description
parameter_id	string
gain	double
offset	double

FormulaConversionReply#

Field	Type	Label	Description
conversion_id	string
comment	string
format	string
units	string
formula	string
inverse	string
return_code	system_monitor_common.ErrorCode

FormulaConversionRequest#

Field	Type	Label	Description
conversion_id	string
comment	string
format	string
units	string
formula	string
inverse	string
overwrite	bool

LoggableReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
loggable	bool
return_code	system_monitor_common.ErrorCode

MapPropertiesReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
x_axis_id	string
y_axis_id	string
x_points	uint32
y_points	uint32
return_code	system_monitor_common.ErrorCode

OffsetReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
offset	double
return_code	system_monitor_common.ErrorCode

OffsetRequest#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
offset	double

Parameter#

Field	Type	Label	Description
id	string
name	string

ParameterErrorsReply#

Field	Type	Label	Description
parameters	ParameterValue	repeated
return_code	system_monitor_common.ErrorCode

ParameterGroup#

Field	Type	Label	Description
id	string
group	string

ParameterGroupsReply#

Field	Type	Label	Description
parameters	ParameterGroup	repeated
return_code	system_monitor_common.ErrorCode

ParameterListReply#

Field	Type	Label	Description
parameters	Parameter	repeated
return_code	system_monitor_common.ErrorCode

ParameterProperties#

Field	Type	Label
Id	string
name	string
description	string
type	system_monitor_common.ParameterType
units	string
format	string
conversion_id	string
groups	string	repeated
data_type	system_monitor_common.DataType
data_size	uint32
lower_engineering_limit	double
upper_engineering_limit	double
max_logging_rate	uint32
prime	bool
read_only	bool
tuneable	bool
multiplexed_ids	string	repeated

ParameterPropertiesReply#

Field	Type	Label	Description
parameters	ParameterProperties	repeated
return_code	system_monitor_common.ErrorCode

ParameterSetValue#

Field	Type	Label	Description
parameter_id	string
value	double

ParameterTypeRequest#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
data_type	system_monitor_common.ParameterType

ParameterValue#

Field	Type	Label	Description
parameter_id	string
value	double
return_code	system_monitor_common.ErrorCode

ParametersReply#

Field	Type	Label	Description
parameter_ids	string	repeated
return_code	system_monitor_common.ErrorCode

RationalConversionReply#

Field	Type	Label	Description
conversion_id	string
coefficient1	double
coefficient2	double
coefficient3	double
coefficient4	double
coefficient5	double
coefficient6	double
comment	string
format	string
units	string
default	string
return_code	system_monitor_common.ErrorCode

RationalConversionRequest#

Field	Type	Label	Description
conversion_id	string
coefficient1	double
coefficient2	double
coefficient3	double
coefficient4	double
coefficient5	double
coefficient6	double
comment	string
format	string
units	string
default	string
overwrite	bool

RowDetailsReply#

Field	Type	Label	Description
row_id	uint32
ident_offset	int32
return_code	system_monitor_common.ErrorCode

RowValues#

Field	Type	Label	Description
values	double	repeated

StringParameterErrorsReply#

Field	Type	Label	Description
parameters	StringParameterValue	repeated
return_code	system_monitor_common.ErrorCode

StringParameterSetValue#

Field	Type	Label	Description
parameter_id	string
value	string

StringParameterValue#

Field	Type	Label	Description
parameter_id	string
value	string
return_code	system_monitor_common.ErrorCode

StringValueReply#

Field	Type	Label	Description
values	StringParameterValue	repeated
return_code	system_monitor_common.ErrorCode

TableConversion#

Field	Type	Label	Description
raw	double
mapped	double

TableConversionReply#

Field	Type	Label
conversion_id	string
comment	string
format	string
units	string
default	string
interpolate	bool
values	TableConversion	repeated
return_code	system_monitor_common.ErrorCode

TableConversionRequest#

Field	Type	Label
conversion_id	string
comment	string
format	string
units	string
default	string
interpolate	bool
values	TableConversion	repeated
overwrite	bool

TextConversion#

Field	Type	Label	Description
raw	double
mapped	string

TextConversionReply#

Field	Type	Label
conversion_id	string
format	string
units	string
default	string
values	TextConversion	repeated
return_code	system_monitor_common.ErrorCode

TextConversionRequest#

Field	Type	Label
conversion_id	string
format	string
units	string
default	string
values	TextConversion	repeated
overwrite	bool

TypeRequest#

Field	Type	Label	Description
data_type	system_monitor_common.ParameterType

UndoRequest#

Field	Type	Label	Description
buffer_type	system_monitor_common.BufferType

ValueReply#

Field	Type	Label	Description
values	ParameterValue	repeated
return_code	system_monitor_common.ErrorCode

WarningLimitsReply#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
low	double
high	double
return_code	system_monitor_common.ErrorCode

WarningLimitsRequest#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
low	double
high	double

SystemMonitorParameter#

Method Name	Request Type	Response Type
GetParameters	AppTypeRequest	ParameterListReply
GetConversions	.system_monitor_common.AppRequest	ConversionListReply
GetParameterAndGroups	.system_monitor_common.AppRequest	ParameterGroupsReply
GetParameterProperties	AppTypeRequest	ParameterPropertiesReply
GetCANParameterProperties	.system_monitor_common.ParametersRequest	CANParameterPropertiesReply
GetMapProperties	.system_monitor_common.ParameterRequest	MapPropertiesReply
GetRowDetails	.system_monitor_common.ParameterRequest	RowDetailsReply
GetParameterBitMask	.system_monitor_common.ParameterRequest	BitMaskReply
GetParameterBitShift	.system_monitor_common.ParameterRequest	BitShiftReply
GetParameterAddress	ParameterTypeRequest	AddressReply
GetParameterByteOrder	.system_monitor_common.ParameterRequest	ByteOrderReply
ParameterLoggable	.system_monitor_common.ParameterRequest	LoggableReply
GetExternalInputGainOffset	ExternalParameterRequest	ExternalReply
SetExternalInputGainOffset	ExternalRequest	.system_monitor_common.Return
GetModifiedParameters	.system_monitor_common.AppRequest	ParameterListReply
GetParameterWarningLimits	.system_monitor_common.ParameterRequest	WarningLimitsReply
SetParameterWarningLimits	WarningLimitsRequest	.system_monitor_common.Return
DeleteMinMax	.google.protobuf.Empty	.system_monitor_common.Return
ExportInputSignals	.system_monitor_common.FileRequest	.system_monitor_common.Return
ImportInputSignals	.system_monitor_common.FileRequest	.system_monitor_common.Return
RegenerateInputSignalParameters	.google.protobuf.Empty	.system_monitor_common.Return
UndoDataChanges	UndoRequest	.system_monitor_common.Return
RestoreValue	.system_monitor_common.ParameterRequest	.system_monitor_common.Return
GetAxisParameterFromMap	.system_monitor_common.ParameterRequest	AxisParametersReply
GetConversionUse	.system_monitor_common.ConversionRequest	ParametersReply
GetConversionType	ConversionNoAppRequest	ConversionTypeReply
GetRationalConversion	ConversionNoAppRequest	RationalConversionReply
GetTableConversion	ConversionNoAppRequest	TableConversionReply
GetTextConversion	ConversionNoAppRequest	TextConversionReply
GetFormulaConversion	ConversionNoAppRequest	FormulaConversionReply
GetAppRationalConversion	.system_monitor_common.ConversionRequest	RationalConversionReply
GetAppTableConversion	.system_monitor_common.ConversionRequest	TableConversionReply
SetRationalConversion	RationalConversionRequest	.system_monitor_common.Return
SetTableConversion	TableConversionRequest	.system_monitor_common.Return
SetTextConversion	TextConversionRequest	.system_monitor_common.Return
SetFormulaConversion	FormulaConversionRequest	.system_monitor_common.Return
GetValueOffset	.system_monitor_common.ParameterRequest	OffsetReply
SetValueOffset	OffsetRequest	.system_monitor_common.Return
ZeroLiveValue	.system_monitor_common.ParameterRequest	.system_monitor_common.Return
GetValueMeasurement	.system_monitor_common.AppParametersRequest	ValueReply
GetValueScalar	.system_monitor_common.AppParametersRequest	ValueReply
GetValue1AxisMap	.system_monitor_common.AppParametersRequest	Array1dValueReply
GetValue2AxisMap	.system_monitor_common.AppParametersRequest	Array2dValueReply
GetValueAxis	.system_monitor_common.AppParametersRequest	Array1dValueReply
GetValueArray	.system_monitor_common.AppParametersRequest	Array1dValueReply
GetValueString	.system_monitor_common.AppParametersRequest	StringValueReply
GetValueCAN	.system_monitor_common.ParametersRequest	ValueReply
GetValueVirtual	.system_monitor_common.ParametersRequest	ValueReply
GetDTVValueScalar	.system_monitor_common.ParametersFileRequest	ValueReply
GetDTVValue1AxisMap	.system_monitor_common.ParametersFileRequest	Array1dValueReply
GetDTVValue2AxisMap	.system_monitor_common.ParametersFileRequest	Array2dValueReply
GetDTVValueAxis	.system_monitor_common.ParametersFileRequest	Array1dValueReply
GetDTVValueArray	.system_monitor_common.ParametersFileRequest	Array1dValueReply
GetDTVValueString	.system_monitor_common.ParametersFileRequest	StringValueReply
SetValueScalar	AppParameterValuesRequest	ParameterErrorsReply
SetValue1AxisMap	AppArray1dParameterValuesRequest	Array1dParameterErrorsReply
SetValue2AxisMap	AppArray2dParameterValuesRequest	Array2dParameterErrorsReply
SetValueAxis	AppArray1dParameterValuesRequest	Array1dParameterErrorsReply
SetValueArray	AppArray1dParameterValuesRequest	Array1dParameterErrorsReply
SetValueString	AppStringParameterValuesRequest	StringParameterErrorsReply

Top

Protos/system_monitor_project.proto#

ActiveAppReply#

Field	Type	Label	Description
app_ids	uint32	repeated
return_code	system_monitor_common.ErrorCode

AppFileRequest#

Field	Type	Label	Description
app_id	uint32
file_path	string

AppReply#

Field	Type	Label	Description
text	string
return_code	system_monitor_common.ErrorCode

Application#

Field	Type	Label	Description
app_id	uint32
app_name	string
return_code	system_monitor_common.ErrorCode

CANMergeRequest#

Field	Type	Label	Description
index	uint32
file_path	string
merge	bool

CANRequest#

Field	Type	Label	Description
index	uint32
file_path	string

CompareAppReply#

Field	Type	Label	Description
parameters	CompareParameter	repeated
return_code	system_monitor_common.ErrorCode

CompareAppRequest#

Field	Type	Label	Description
app_id	uint32
dtv1_path	string
dtv2_path	string

CompareParameter#

Field	Type	Label	Description
parameter_id	string
type	system_monitor_common.ParameterType
reason1	ReasonCode
reason2	ReasonCode

DTVModifiedReply#

Field	Type	Label	Description
modified	bool
return_code	system_monitor_common.ErrorCode

DTVSaveCopyRequest#

Field	Type	Label	Description
app_id	uint32
save_path	string
comment	string
notes	string
consortium	string

DTVSaveIncrementRequest#

Field	Type	Label	Description
app_id	uint32
comment	string
notes	string

DTVSaveRequest#

Field	Type	Label	Description
app_id	uint32
save_path	string
comment	string
notes	string

DTVSavedOnReply#

Field	Type	Label	Description
saved_on	string
return_code	system_monitor_common.ErrorCode

DetailsRequest#

Field	Type	Label	Description
app_id	uint32
text	string

EnableRequest#

Field	Type	Label	Description
enable	bool

ErrorDefinition#

Field	Type	Label	Description
id	string
name	string
description	string
group	string
bit_number	uint32
current	string
logged	string

ErrorDefinitionsReply#

Field	Type	Label	Description
error_definitions	ErrorDefinition	repeated
return_code	system_monitor_common.ErrorCode

ErrorInstance#

Field	Type	Label	Description
name	string
description	string
status	system_monitor_common.ErrorStatus

ErrorReply#

Field	Type	Label	Description
error_instances	ErrorInstance	repeated
return_code	system_monitor_common.ErrorCode

Event#

Field	Type	Label	Description
id	uint32
name	string
priority	system_monitor_common.EventPriority

EventReply#

Field	Type	Label	Description
event_id	uint32
description	string
conversion_id1	string
conversion_id2	string
conversion_id3	string
priority	system_monitor_common.EventPriority
return_code	system_monitor_common.ErrorCode

EventRequest#

Field	Type	Label	Description
app_id	uint32
event_id	uint32

EventsReply#

Field	Type	Label	Description
events	Event	repeated
return_code	system_monitor_common.ErrorCode

ExistsReply#

Field	Type	Label	Description
exists	bool
return_code	system_monitor_common.ErrorCode

ExistsRequest#

Field	Type	Label	Description
app_id	uint32
parameter_id	string
data_type	system_monitor_common.ParameterType
return_code	system_monitor_common.ErrorCode

FileDetailsReply#

Field	Type	Label	Description
saved_by	string
saved_on	google.protobuf.Timestamp
comment	string
notes	string
build	uint32
consortium	string
owner	string
rda	string
return_code	system_monitor_common.ErrorCode

FileNameRequest#

Field	Type	Label	Description
file_type	system_monitor_common.FileType
slot	uint32

FileNewRequest#

Field	Type	Label	Description
file_type	system_monitor_common.FileType
file_path	string
save_existing	bool
overwrite	bool

FileOpenRequest#

Field	Type	Label	Description
file_type	system_monitor_common.FileType
file_path	string
slot	uint32
activate	bool

FileReply#

Field	Type	Label	Description
file_path	string
return_code	system_monitor_common.ErrorCode

FileSaveRequest#

Field	Type	Label	Description
file_type	system_monitor_common.FileType
file_path	string
comment	string
notes	string
consortium	string
save_copy_as	bool

GetAppDetailsReply#

Field	Type	Label	Description
apps	Application	repeated
return_code	system_monitor_common.ErrorCode

GetBuildNumberReply#

Field	Type	Label	Description
build_number	uint32
return_code	system_monitor_common.ErrorCode

GetVersionNumberReply#

Field	Type	Label	Description
major_version	uint32
minor_version	uint32
build_version	uint32
return_code	system_monitor_common.ErrorCode

MatlabDTVRequest#

Field	Type	Label
dtv_path	string
export_path	string
data_only	bool
data_types	system_monitor_common.ParameterType	repeated

MatlabRequest#

Field	Type	Label
app_id	uint32
export_path	string
data_only	bool
data_types	system_monitor_common.ParameterType	repeated

MatlabSelectedRequest#

Field	Type	Label
app_id	uint32
export_path	string
data_only	bool
parameter_ids	string	repeated

MultiAppReply#

Field	Type	Label	Description
app_ids	uint32	repeated
return_code	system_monitor_common.ErrorCode

MultiAppRequest#

Field	Type	Label	Description
app_ids	uint32	repeated

PGVIDReply#

Field	Type	Label	Description
pgv_id	uint32
return_code	system_monitor_common.ErrorCode

ParameterIdRequest#

Field	Type	Label	Description
parameter_id	string

ProjectCloseRequest#

Field	Type	Label	Description
action	int32

ProjectCreateRequest#

Field	Type	Label
project_path	string
app_paths	string	repeated
desktop_path	string
virtuals_path	string
can_path	string
logging_config_path	string

ProjectExportRequest#

Field	Type	Label	Description
save_modified	bool

ProjectImportRequest#

Field	Type	Label	Description
project_path	string
base	string

ProjectSaveAsRequest#

Field	Type	Label	Description
project_name	string
save_all	bool
comments	string
notes	string

ProjectSaveRequest#

Field	Type	Label	Description
save_all	bool

ReasonCode#

Field	Type	Label	Description
reasons	system_monitor_common.Reason	repeated

ReprogramRequest#

Field	Type	Label	Description
app_ids	uint32	repeated
force	bool

SensorRequest#

Field	Type	Label	Description
app_id	uint32
sensor	string
serial_number	int32

SlotActiveRequest#

Field	Type	Label	Description
slot	uint32
active	bool

SlotReply#

Field	Type	Label	Description
active	bool
return_code	system_monitor_common.ErrorCode

SlotRequest#

Field	Type	Label	Description
slot	uint32

SyncedReply#

Field	Type	Label	Description
synced	bool
return_code	system_monitor_common.ErrorCode

SystemMonitorProject#

Method Name	Request Type	Response Type
ProjectOpen	.system_monitor_common.FileRequest	.system_monitor_common.Return
ProjectClose	ProjectCloseRequest	.system_monitor_common.Return
ProjectCreate	ProjectCreateRequest	.system_monitor_common.Return
ProjectSave	ProjectSaveRequest	.system_monitor_common.Return
ProjectSaveAs	ProjectSaveAsRequest	.system_monitor_common.Return
ProjectImport	ProjectImportRequest	.system_monitor_common.Return
ProjectExport	ProjectExportRequest	.system_monitor_common.Return
Reprogram	ReprogramRequest	.system_monitor_common.Return
DownloadDataChanges	.system_monitor_common.AppRequest	.system_monitor_common.Return
EditBufferSynced	.system_monitor_common.AppRequest	SyncedReply
UploadDataVersion	.system_monitor_common.AppRequest	.system_monitor_common.Return
GetVersionNumber	.google.protobuf.Empty	GetVersionNumberReply
GetPGVVersion	.system_monitor_common.AppRequest	AppReply
GetPGVID	.system_monitor_common.AppRequest	PGVIDReply
GetDTVVersion	.system_monitor_common.AppRequest	AppReply
GetEcuDTVVersion	.system_monitor_common.AppRequest	AppReply
GetNextDTVVersion	.system_monitor_common.AppRequest	AppReply
GetDTVModified	.system_monitor_common.AppRequest	DTVModifiedReply
GetDTVSavedOn	.system_monitor_common.AppRequest	DTVSavedOnReply
GetDTVNotes	.system_monitor_common.AppRequest	AppReply
SetDTVNotes	DetailsRequest	.system_monitor_common.Return
ClearDTVNotes	.system_monitor_common.AppRequest	.system_monitor_common.Return
GetDTVComment	.system_monitor_common.AppRequest	AppReply
SetDTVComment	DetailsRequest	.system_monitor_common.Return
EnableDTVBackup	EnableRequest	.system_monitor_common.Return
DTVOpen	.system_monitor_common.FileRequest	.system_monitor_common.Return
DTVSave	DTVSaveRequest	.system_monitor_common.Return
DTVSaveCopy	DTVSaveCopyRequest	.system_monitor_common.Return
DTVSaveIncrement	DTVSaveIncrementRequest	.system_monitor_common.Return
GetBuildNumber	.google.protobuf.Empty	GetBuildNumberReply
GetAppDetails	.google.protobuf.Empty	GetAppDetailsReply
GetActiveApps	.google.protobuf.Empty	ActiveAppReply
SetActiveApps	MultiAppRequest	.system_monitor_common.Return
AddApp	.system_monitor_common.FileRequest	.system_monitor_common.Return
RemoveApp	.system_monitor_common.AppRequest	.system_monitor_common.Return
CompareApp	CompareAppRequest	CompareAppReply
GetAppPULFile	.system_monitor_common.AppRequest	FileReply
SetAppPULFile	AppFileRequest	.system_monitor_common.Return
GenerateParamSet	.system_monitor_common.ParametersFileRequest	.system_monitor_common.Return
GeneratePULFile	.system_monitor_common.AppParametersFileRequest	.system_monitor_common.Return
GeneratePULFileFromParamSet	AppFileRequest	FileReply
ChangeSensorSerialNumber	SensorRequest	.system_monitor_common.Return
FileOpen	FileOpenRequest	.system_monitor_common.Return
FileSave	FileSaveRequest	.system_monitor_common.Return
FileNew	FileNewRequest	.system_monitor_common.Return
GetFileName	FileNameRequest	FileReply
GetFileDetails	.system_monitor_common.FileRequest	FileDetailsReply
CreateFFCFromPGV	.system_monitor_common.FileRequest	.system_monitor_common.Return
ExportToHexFile	.system_monitor_common.AppRequest	.system_monitor_common.Return
GetActiveCANConfig	SlotRequest	SlotReply
SetActiveCANConfig	SlotActiveRequest	.system_monitor_common.Return
GetFIACANConfig	SlotRequest	SlotReply
SetFIACANConfig	SlotActiveRequest	.system_monitor_common.Return
CANBuffersExport	CANRequest	.system_monitor_common.Return
CANBuffersImport	CANRequest	.system_monitor_common.Return
CANMessagesExport	CANRequest	.system_monitor_common.Return
CANMessagesImport	CANMergeRequest	.system_monitor_common.Return
CANConfigUnload	SlotRequest	.system_monitor_common.Return
GetActiveLoggingConfig	SlotRequest	SlotReply
SetActiveLoggingConfig	SlotActiveRequest	.system_monitor_common.Return
LoggingConfigUnload	SlotRequest	.system_monitor_common.Return
MatlabImport	.system_monitor_common.FileRequest	.system_monitor_common.Return
MatlabExport	MatlabRequest	.system_monitor_common.Return
MatlabExportDTV	MatlabDTVRequest	.system_monitor_common.Return
MatlabExportSelected	MatlabSelectedRequest	.system_monitor_common.Return
AddParametersToUnlockList	.system_monitor_common.AppParametersFileRequest	FileReply
RemoveParametersFromUnlockList	.system_monitor_common.AppParametersFileRequest	FileReply
GetAppsHoldingParam	ParameterIdRequest	MultiAppReply
GetAppsHoldingMeasurementParam	ParameterIdRequest	MultiAppReply
GetAppsHoldingControlParam	ParameterIdRequest	MultiAppReply
ParameterExists	ExistsRequest	ExistsReply
RegisterEnhancedRowParameters	.system_monitor_common.AppParametersRequest	.system_monitor_common.Return
ClearEnhancedRowParameters	.system_monitor_common.AppRequest	.system_monitor_common.Return
RegisterCANEnhancedRowParameters	.system_monitor_common.ParametersRequest	.system_monitor_common.Return
RegisterVirtualEnhancedRowParameters	.system_monitor_common.ParametersRequest	.system_monitor_common.Return
ActivateEnhancedRowParameters	.google.protobuf.Empty	.system_monitor_common.Return
DumpEvents	.system_monitor_common.FileRequest	.system_monitor_common.Return
DumpErrors	.system_monitor_common.FileRequest	.system_monitor_common.Return
DumpRowData	.system_monitor_common.FileRequest	.system_monitor_common.Return
ClearEvents	.google.protobuf.Empty	.system_monitor_common.Return
GetEvents	.system_monitor_common.AppRequest	EventsReply
GetEventDetails	EventRequest	EventReply
GetErrorDefinitions	.system_monitor_common.AppRequest	ErrorDefinitionsReply
GetErrors	.google.protobuf.Empty	ErrorReply
DeleteErrors	.google.protobuf.Empty	.system_monitor_common.Return

Top

Protos/system_monitor_system.proto#

BatchModeRequest#

Field	Type	Label	Description
mode	bool

CreatePGVReply#

Field	Type	Label	Description
pgv_file_path	string
dtv_file_path	string
return_code	system_monitor_common.ErrorCode

CreatePGVRequest#

Field	Type	Label	Description
location	string
asap2_file_path	string
hex_file_path	string
controllers_file_path	string
errors_file_path	string
events_file_path	string
adjustment_file_path	string
sensors_file_path	string
injector_file_path	string
sensor_enable_file_path	string
live_auto_tune_file_path	string
comments	string
notes	string

DeviceProperties#

Field	Type	Label	Description
comms_path	string
device_name	string
ip_address	string
serial_number	int32

DevicePropertiesReply#

Field	Type	Label	Description
devices	DeviceProperties	repeated
return_code	system_monitor_common.ErrorCode

FolderReply#

Field	Type	Label	Description
file_path	string
return_code	system_monitor_common.ErrorCode

LicenceDetailsReply#

Field	Type	Label	Description
consortium	string
owner	string
return_code	system_monitor_common.ErrorCode

LiveLoggingReply#

Field	Type	Label	Description
live_logging_state	bool
return_code	system_monitor_common.ErrorCode

LiveLoggingRequest#

Field	Type	Label	Description
state	bool

LiveUpdateRequest#

Field	Type	Label	Description
state	bool
action	uint32

MultiApplicationBaseInfo#

Field	Type	Label	Description
name	string
path	string
return_code	system_monitor_common.ErrorCode

MultiApplicationBasesReply#

Field	Type	Label	Description
info	MultiApplicationBaseInfo	repeated
return_code	system_monitor_common.ErrorCode

MultiApplicationBasesRequest#

Field	Type	Label	Description
base_name	string

OnlineRequest#

Field	Type	Label	Description
state	bool

SendMessageReply#

Field	Type	Label	Description
messages	int32	repeated
return_code	system_monitor_common.ErrorCode

SendMessageRequest#

Field	Type	Label
app_id	uint32
timeout	uint32
retries	uint32
messages	int32	repeated

StatusReply#

Field	Type	Label	Description
link_status	LinkStatus
online	bool
live_update	bool
return_code	system_monitor_common.ErrorCode

UnitByIndexRequest#

Field	Type	Label	Description
index	uint32

UnitByIndexTypeRequest#

Field	Type	Label	Description
index	uint32
primary	bool

UnitInfo#

Field	Type	Label	Description
name	string
type	string
ip_address	string
return_code	system_monitor_common.ErrorCode

UnitListReply#

Field	Type	Label	Description
info	UnitInfo	repeated
return_code	system_monitor_common.ErrorCode

UnitNameReply#

Field	Type	Label	Description
name	string
return_code	system_monitor_common.ErrorCode

LinkStatus#

Name	Number	Description
Link_OK	0
Link_NOK	1
Controller_Busy	2
In_Boot	3
Zone_1	4
Zone_2	5
Zone_3	6
Bad_Response	7
Invalid_Device	8
Unknown	65535

SystemMonitorSystem#

Method Name	Request Type	Response Type
GetStatus	.google.protobuf.Empty	StatusReply
SetOnline	OnlineRequest	.system_monitor_common.Return
SetLiveUpdate	LiveUpdateRequest	.system_monitor_common.Return
GetUnitList	.google.protobuf.Empty	UnitListReply
GetUnitName	.google.protobuf.Empty	UnitNameReply
GetUnitByIndex	UnitByIndexRequest	UnitInfo
SetUnitByIndex	UnitByIndexTypeRequest	.system_monitor_common.Return
GetMultiApplicationBases	.google.protobuf.Empty	MultiApplicationBasesReply
GetMultiApplicationBase	.google.protobuf.Empty	MultiApplicationBaseInfo
SetMultiApplicationBase	MultiApplicationBasesRequest	.system_monitor_common.Return
GetLicenceDetails	.google.protobuf.Empty	LicenceDetailsReply
GetDeviceProperties	.google.protobuf.Empty	DevicePropertiesReply
GetLiveLogging	.google.protobuf.Empty	LiveLoggingReply
SetLiveLogging	LiveLoggingRequest	.system_monitor_common.Return
SetBatchMode	BatchModeRequest	.system_monitor_common.Return
SendMessage	SendMessageRequest	SendMessageReply
GetLogFolder	.google.protobuf.Empty	FolderReply
GetPPOFileName	.google.protobuf.Empty	FolderReply
CreatePGV	CreatePGVRequest	CreatePGVReply

Top

Protos/system_monitor_virtual.proto#

AddGroupRequest#

Field	Type	Label	Description
group_path	string
name	string
description	string
read_only	bool

VirtualExportRequest#

Field	Type	Label	Description
file_path	string
group	string

VirtualGroupReply#

Field	Type	Label	Description
name	string
description	string
read_only	bool
return_code	system_monitor_common.ErrorCode

VirtualGroupRequest#

Field	Type	Label	Description
group	string

VirtualGroupsReply#

Field	Type	Label	Description
ids	string	repeated
return_code	system_monitor_common.ErrorCode

VirtualParameter#

Field	Type	Label	Description
id	string
return_code	system_monitor_common.ErrorCode

VirtualParameterDataTypeRequest#

Field	Type	Label	Description
Id	string
data_type	system_monitor_common.DataType

VirtualParameterProperties#

Field	Type	Label	Description
Id	string
name	string
description	string
lower_display_limit	double
upper_display_limit	double
min_logging_rate	uint32
scaling_factor	uint32
min_not_defined	bool
expression	string
units	string
format	string
group	string
conversion_id	string
data_type	system_monitor_common.DataType
return_code	system_monitor_common.ErrorCode

VirtualParameterPropertiesReply#

Field	Type	Label	Description
parameters	VirtualParameterProperties	repeated
return_code	system_monitor_common.ErrorCode

VirtualParameterRequest#

Field	Type	Label	Description
id	string
name	string
description	string
min_display	double
max_display	double
Min_logging_rate	int32
scaling_factor	int32
is_min_not_def	bool
expression	string
conversion_id	string
overwrite	bool
units	string
format_override	string
group	string
data_type	system_monitor_common.DataType
lower_warning	double
upper_warning	double

VirtualReply#

Field	Type	Label	Description
ids	VirtualParameter	repeated
return_code	system_monitor_common.ErrorCode

VirtualsRequest#

Field	Type	Label	Description
ids	string	repeated

SystemMonitorVirtual#

Method Name	Request Type	Response Type
SetVirtualParameter	VirtualParameterRequest	.system_monitor_common.Return
GetVirtualParameterProperties	.system_monitor_common.ParametersRequest	VirtualParameterPropertiesReply
RemoveVirtualParameters	VirtualsRequest	VirtualReply
RemoveAllVirtualParameters	.google.protobuf.Empty	.system_monitor_common.Return
RemoveVirtualConversions	VirtualsRequest	VirtualReply
RemoveAllVirtualConvertions	.google.protobuf.Empty	.system_monitor_common.Return
GetVirtualParameterGroups	.google.protobuf.Empty	VirtualGroupsReply
GetVirtualParameterGroup	VirtualGroupRequest	VirtualGroupReply
GetVirtualParametersInGroup	VirtualGroupRequest	VirtualGroupsReply
VirtualParametersExport	VirtualExportRequest	.system_monitor_common.Return
VirtualParametersImport	.system_monitor_common.FileRequest	.system_monitor_common.Return
AddVirtualParameterGroup	AddGroupRequest	.system_monitor_common.Return
RemoveVirtualParameterGroup	VirtualGroupRequest	.system_monitor_common.Return
RemoveAllVirtualParametersFromGroup	VirtualGroupRequest	.system_monitor_common.Return
SetVirtualParameterDataType	VirtualParameterDataTypeRequest	.system_monitor_common.Return

Scalar Value Types#

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)