Skip to content

Protocol Documentation#

Table of Contents#

Top

Protos/system_monitor_common.proto#

AppParametersFileRequest#

System Monitor Application Parameters File Request

Field Type Label Description
app_id uint32 Application identifier
parameter_ids string repeated Parameter identifiers.
file_path string File path.

AppParametersRequest#

System Monitor Application Parameters Request

Field Type Label Description
app_id uint32 Application Id. 0 for all applications including Virtual and CAN.
parameter_ids string repeated Parameter identifiers.

AppRequest#

System Monitor App Request

Field Type Label Description
app_id uint32 Application id.

ConversionRequest#

System Monitor Conversion Request

Field Type Label Description
app_id uint32 Application id.
conversion_id string Conversion id.

FileRequest#

System Monitor File Request

Field Type Label Description
file_path string File path.

ParameterRequest#

System Monitor Parameter Request

Field Type Label Description
app_id uint32 Application id.
parameter_id string Parameter id.

ParametersFileRequest#

System Monitor Parameters File Request

Field Type Label Description
parameter_ids string repeated Parameter identifiers.
file_path string File path.

ParametersRequest#

System Monitor Parameters Request

Field Type Label Description
parameter_ids string repeated Identifiers of parameters to request

Return#

System Monitor Return Message

Field Type Label Description
return_code ErrorCode Return code.

BufferType#

System Monitor Buffer Types

Name Number Description
unit_buffer 0 Data Changes in Unit.
edit_buffer 1 Data Changes in Edit Buffer.
unit_and_edit_buffer 2 Data Changes in Unit & Edit Buffer.

ByteOrder#

System Monitor Byte Orders

Name Number Description
msb_first 0 Most significant bit first
msb_last 1 Most significant bit last

ConversionType#

System Monitor Conversion Types

Name Number Description
rational 0 Rational conversion
table 1 Table conversion
text 2 Text conversion
formula 3 Formula conversion

DataType#

System Monitor Data Types

Name Number Description
ubyte 0 Unsigned byte
byte 1 Signed Byte
uword 2 Unsigned word
word 3 Signed word
ulong 4 Unsigned long
long 5 Signed long
float 6 Float
unknown 7 Unknown
qword 8 Quad word
sqword 9 Signed quad word
double 10 Double

ErrorCode#

System Monitor Error Codes

Name Number Description
no_error 0 No error, function successful
no_project -1 No project loaded in SM-V7
no_licence -2 No licence for requested function
non_specific -3 Non-specific error
data_version_mismatch -4 Data version mismatch
no_data_version -5 No data version loaded
no_program_version -6 No program version loaded
no_ECU -7 No ECU connected
invalid_file -8 Invalid file specified
no_application -9 The open project does not cover the specified application
application_inactive -10 Application must be active in order to support this operation
live_updates_on -11 Operation not allowed while live updates are on
TAGtronic_onlu -12 This command only valid for TAGtronic systems.
SM_busy -13 SM cannot accept API calls at the moment (might be in critical operation).
message_argument_mismatch -20 Type mismatch in argument of SendMessage , expected array of WORDs passed by reference
message_dimension_mismatch -21 Array dimension mismatch in argument of SendMessage, expected a 1-dimensional array
message_lower_bound_non_zero -22 Lower bound of argument of SendMessage call was not 0
bounds_error -23 Unexpected error getting bounds of SendMessage argument
message_argument_error -24 Error in ReplyMessage argument
message_argument_invalid -25 Error in SendMessage argument
fdl_not_parsed -26 Virtual Parameter contains invalid FDL.
conversion_invalid -27 Conversion for Parameter does not exist/is invalid.
parameter_invalid -28 Parameter name does not exist/is invalid.
parameter_override_not_allowed -29 Parameter exists and not allowed to override.
bad_state -30 Request cannot be actioned as incorrect SM state.
invalid_command -31 Command passed to SM is not valid.
no_data_present -32 Missing document or similar
bad_memory_allocation -33 Memory allocation failed
partially_complete -34 Operation only partially complete. Example: ClearRemoteParams left Parameters used in trigger conditions.
document_full -35 Indicates the current document (config) is full.
parameter_identifier_already_exists -36 Parameter Identifier already exists in another application.
parameter_read_only -37 Parameter is read-only - write access denied.
parameter_non_live_tuneable -38 Parameter is non-live tuneable - write access denied.
group_not_found -39 Requested group is not found
file_requires_saving -40 Previous virtual parameters file has been modified and not saved
frequency_overridden -41 No customer base found for the project being opened
no_customer_base -42 Requested parameter not found
parameter_not_found -100 Specified parameter does not exist in current program version
error_read_only -101 Tried to set a read only parameter
error_limits -102 Tried to set a parameter outside its limits
error_monotony -103 Axis monotony restrictions not adhered to
error_axis_pt -104 Tried to get or set parameter or axis value at invalid breakpoint
error_address -105 Parameter had invalid address
error_non_num -106 String containing non numeric characters supplied to set function
error_size -107 Exceeded specified size or array or string parameter
error_live_tune -108 Live tune enabled, failed to update value in ECU
error_intp -109 Tried to get interpolated value but no input quantity or axis points
error_activelayer -110 No active live auto tune "layer" (group)
error_tolerance -111 Operating point is outside breakpoint tolerances (e.g. for live auto tune)
error_axis_change -112 Number of axis breakpoints has changed between program versions
error_no_live_tune -113 Parameter is not modifiable in live tune area (warning only, not error)
error_validation -114 The attempt to validate the value in the unit failed (not the same as the value being invalid)
error_live_tune_data_invalid -115 The live tune data is invalid
error_serial_not_found -116 Serial number not found for sensor channel
error_unknown -117 An unknown error
error_cancel -118 Attempt to set value cancelled (by user or because of invalid input)
error_locked_param -119 Access denied, parameter locked by RDA
error_value_not_matching_entry -120 Value set does not match value in the unit
detail_unknown -200 Session detail does not exist
dump_row_data_failed -201 Failed to dump row data
live_update_failed -300 Failed to enter live tune
online_failed -301 Failed to go online
download_data_failed -302 Failed to download data
system_not_running -303 System monitor is only running in OLE mode, hence can't perform requested action
parameter_locked -304 Attempt to access a locked parameter
comms_base -1000 Communications base error

ErrorStatus#

System Monitor Error Statuses

Name Number Description
status_unknown 0 Unknown error status.
status_current 1 Current error status.
status_logged 2 Logged error status.

EventPriority#

System Monitor Event Priority

Name Number Description
event_high 0 High priority event.
event_medium 1 Medium priority event.
event_low 2 Low priority event.
event_debug 3 Debug event.

FileType#

System Monitor File Types

Name Number Description
Project 0 Project file
PGV 1 Program version file
DTV 2 Data version file
desktop 3 Desktop file
logging_config 4 Logging config file
virtuals 5 Virtual parameter file
CAN 6 Can parameter file
live_logging 7 Live logging configuration file
pot_board 8 Pot board file

LoggingType#

System Monitor Logging Types

Name Number Description
frequency 0 Frequency value
cylinder 1 Engine segment (cylinder)
cycle 2 Cycle (wValue not used).
unknown_logging 3 Unknown
edge 4 Edge

ParameterType#

System Monitor Parameter Types

Name Number Description
undefined 0 Undefined parameter type
scalar 1 Scalar parameter
axis_1 2 Axis 1 parameter
axis_2 4 Axis 2 parameter
array 16 Array parameter
string 32 String parameter
ecu 128 Ecu parameter
can 256 Can parameter
tsb 512 TAG Sensor Bus parameter
virtual 1024 Virtual parameter
axis 196608 Axis parameter
input 268435456 Input parameter
measurement 268437376 Measurement parameter

Reason#

System Monitor Reasons

Name Number Description
none 0 No difference.
absent 1 Not present in program version of the candidate.
different 2 Major difference that prevents merge.
equal 4 Same data type, size and value.
different_value 8 Same data type, size, units, diff value.
different_size 16 Same data type, different size (maps only).
different_conv 32 Different display format conversion.
different_units 64 Different units.
different_type 128 Different data type.
different_comment 256 Different comment.
different_def_value 512 Different default value.
absent_master 1024 Not present in program version of the edit buffer.
locked 268435456 Locked.

TriggerOperator#

System Monitor Trigger Operators

Name Number Description
equals 0 Equals.
less_than 1 Less than.
greater_than 2 Greater than.
not_equal_to 3 Not equal to.
greater_than_or_equal 4 Greater than or equal to.
less_than_or_equal 5 Less than or equal to.

TriggerType#

System Monitor Trigger Types

Name Number Description
on_data 0 On Data (with parameter)
driver_push 1 Driver push (not supported)
ignition_on 2 Ignition On
lap_trigger 3 Lap trigger
no_condition 4 No condition
external_trigger 5 External trigger

Top

Protos/system_monitor_logging.proto#

AddParameterRequest#

Field Type Label Description
app_id uint32 Application Id
parameter_id string Unique parameter identifier
logging_rate LoggingChannelValue repeated Logging channel values

AddVirtualParameterRequest#

Field Type Label Description
parameter_id string Unique parameter identifier
logging_rate LoggingChannelValue repeated The logging channel value

ChannelProperties#

Field Type Label Description
index uint32 The 1 based channel index to modify
name string Name of the channel
log_logging bool Retrieves the Log to Unit flag
log_telemetry bool Retrieves the telemetry flag
logging_rate double The channel logging rate
telemetry_rate double The telemetry logging rate
trigger_rearm bool Trigger re-arms after stop condition
slot uint32 Retrieves the slot position of the configuration defining the channel

ChannelPropertiesReply#

Field Type Label Description
channels ChannelProperties repeated The logging channel properties
return_code system_monitor_common.ErrorCode Return code

ChannelRequest#

Field Type Label Description
index uint32 The 0 based channel index to modify
name string Name of the channel
log_to_unit bool Retrieves the Log to Unit flag
log_telemetry bool Retrieves the telemetry flag
trigger_rearm bool Trigger re-arms after stop condition

ClearRequest#

Field Type Label Description
remove_triggers bool Request System Monitor removes all parameters, including those used by triggers

ConfigReply#

Field Type Label Description
config_name string Name of the ECU logging configuration
return_code system_monitor_common.ErrorCode Return code

DownloadProgressReply#

Field Type Label Description
in_progress bool Indicates whether a download is in progress
return_code system_monitor_common.ErrorCode Return code

DownloadReply#

Field Type Label Description
optional_value string Indicates whether the logging configuration download is complete
return_code system_monitor_common.ErrorCode Return code

DownloadRequest#

Field Type Label Description
optional_app_id uint32 Application id
optional_parameter_id string Unique identifier of logging configuration parameter
optional_delay_ms uint32 Read delay in ms before retrieving parameter value allowing ECU configuration processing time

GetSessionDetailReply#

Field Type Label Description
name string Name of session detail
value string Value of session detail
return_code system_monitor_common.ErrorCode Return code

GetSessionDetailRequest#

Field Type Label Description
name string Name of session detail

LoggingChannelValue#

Field Type Label Description
channel_id uint32 Channel id
type system_monitor_common.LoggingType Logging type
value uint32 Logging channel value

LoggingDurationReply#

Field Type Label Description
estimated_time google.protobuf.Duration Estimated time available in recording memory
estimated_laps double Estimated laps available in recording memory.
return_code system_monitor_common.ErrorCode Return code

LoggingOffsetReply#

Field Type Label Description
offset uint32 The current logging offset
return_code system_monitor_common.ErrorCode Return code

LoggingOffsetRequest#

Field Type Label Description
offset uint32 The logging offset

LoggingParameter#

Field Type Label Description
app_id uint32 Application id
parameter_id string Parameter id
parameter_name string Parameter name
parameter_description string Parameter description
data_size uint32 Size of data
values LoggingChannelValue repeated Logging channel values
slot uint32 Slot position of configuration defining the parameter

LoggingParametersReply#

Field Type Label Description
parameters LoggingParameter repeated The logging parameters
channel_names string repeated The channel names
return_code system_monitor_common.ErrorCode Return code

SetSessionDetailRequest#

Field Type Label Description
name string Name of session detail
value string New value for session detail

SlotCountReply#

Field Type Label Description
slot_count uint32 Number of available slots
return_code system_monitor_common.ErrorCode Return code

SlotPercentageReply#

Field Type Label Description
app_id uint32 Application id
parameter_id string Parameter id
slot_percentage double The current percentage
return_code system_monitor_common.ErrorCode Return code

Trigger#

Field Type Label Description
index uint32 The 0 based channel index to retrieve
start_conditions TriggerCondition repeated The trigger start conditions
stop_conditions TriggerCondition repeated The trigger start conditions
start_post_trigger int32 Retrieves the delay for the start trigger
stop_post_trigger int32 Retrieves the delay for the stop trigger
slot uint32 Retrieves the slot position of the configuration defining the channel

TriggerCondition#

Field Type Label Description
index uint32 Specifies which condition index (0 <= n < 6), where the first 3 are start conditions, and the later, stop conditions
type system_monitor_common.TriggerType Retrieves the trigger condition type
parameter_id string Retrieves the parameter used in > On Data = condition type. If any
app_id uint32 Retrieves the application ID, that the pszParamName belongs to
operator system_monitor_common.TriggerOperator Retrieves the condition operator of the > On Data = type
threshold double Retrieves the floating point number to compare in condition against specified parameter for type > On Data =
repeat_count uint32 Retrieves the number of times a condition should occur before it is considered true

TriggerRequest#

Field Type Label Description
index uint32 The 0 based channel index to set
start_conditions TriggerCondition repeated The trigger start conditions
stop_conditions TriggerCondition repeated The trigger end conditions
start_post_trigger int32 The delay for the start trigger
stop_post_trigger int32 The delay for the stop trigger

TriggersReply#

Field Type Label Description
triggers Trigger repeated The available triggers
return_code system_monitor_common.ErrorCode Return code

WrapReply#

Field Type Label Description
wrap bool Required wrapping memory strategy
return_code system_monitor_common.ErrorCode Return code

WrapRequest#

Field Type Label Description
wrap bool Required wrapping memory strategy

SystemMonitorLogging#

Method Name Request Type Response Type Description
GetLoggingChannelProperties .google.protobuf.Empty ChannelPropertiesReply Gets the properties of the available logging channels
SetLoggingChannelProperties ChannelRequest .system_monitor_common.Return Alters the properties of any given Remote Logging channel. (COM: SetRemoteChannelProperties)
GetLoggingTriggers .google.protobuf.Empty TriggersReply Retrieves the properties of all channel trigger settings
SetLoggingTrigger TriggerRequest .system_monitor_common.Return Modify or create a given channel's trigger condition
GetLoggingWrap .google.protobuf.Empty WrapReply Gets the remote logging config memory wrapping strategy
SetLoggingWrap WrapRequest .system_monitor_common.Return Sets the remote logging config memory wrapping strategy
GetLoggingOffset .google.protobuf.Empty LoggingOffsetReply Gets the remote logging config offset
SetLoggingOffset LoggingOffsetRequest .system_monitor_common.Return Sets the remote logging config offset
GetLoggingSessionDetails GetSessionDetailRequest GetSessionDetailReply Returns the current value of a specified session detail from the remote logging configuration
SetLoggingSessionDetails SetSessionDetailRequest .system_monitor_common.Return Sets a specified session detail in the remote logging configuration
GetLoggingDuration .google.protobuf.Empty LoggingDurationReply Get the estimated length in time and number of laps available for recording in the remote logging config
GetLoggingParameterDetails .google.protobuf.Empty LoggingParametersReply Gets the remote logging parameter details from the config
LoggingConfigDownloadInProgress .google.protobuf.Empty DownloadProgressReply Gets whether a logging config download is in progress
LoggingConfigDownload DownloadRequest DownloadReply Downloads the remote logging configuration to the ECU then reads the given measurement value to ensure configuration write is complete
LoggingConfigUpload .google.protobuf.Empty .system_monitor_common.Return Uploads the remote logging configuration from the ECU
RemoveLoggingParameter .system_monitor_common.ParameterRequest .system_monitor_common.Return Remove a parameter from the Remote Logging Configuration
ClearAllLoggingParameters ClearRequest .system_monitor_common.Return Removes all the parameters from the remote logging config except those used by triggers If the caller specifies a forceful removal all parameters will be removed and any >On Data= trigger conditions will be reset
GetLoggingSlotsUsed .google.protobuf.Empty SlotCountReply Gets the number of logging slots
GetLoggingSlotPercentage .system_monitor_common.ParameterRequest SlotPercentageReply Gets the percentage of a logging slot used by a parameter
GetECULoggingConfig .google.protobuf.Empty ConfigReply Gets the logging configuration from the ECU
AddLoggingParameter AddParameterRequest .system_monitor_common.Return Adds a parameter to the Remote Logging Configuration
AddVirtualLoggingParameter AddVirtualParameterRequest .system_monitor_common.Return Adds a virtual parameter to the Remote Logging Configuration

Top

Protos/system_monitor_parameter.proto#

AddressReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
address uint32 Parameter address.
ident uint32 Ident returned.
return_code system_monitor_common.ErrorCode Return code.

AppArray1dParameterValuesRequest#

Field Type Label Description
app_id uint32 Id of the application.
parameters Array1dParameterSetValue repeated Parameter values to set.

AppArray2dParameterValuesRequest#

Field Type Label Description
app_id uint32 Id of the application.
parameters Array2dParameterSetValue repeated Parameter values to set.

AppParameterValuesRequest#

Field Type Label Description
app_id uint32 Id of the application.
parameters ParameterSetValue repeated Parameter values to set.

AppStringParameterValuesRequest#

Field Type Label Description
app_id uint32 Id of the application.
parameters StringParameterSetValue repeated Parameter values to set.

AppTypeRequest#

Field Type Label Description
app_id uint32 Id of the application
data_type system_monitor_common.ParameterType Parameter data type. - One of ParameterType.Undefined, ParameterType.scalar, ParameterType.axis_1, ParameterType.axis_2, ParameterType.array, ParameterType.string, ParameterType.Can, ParameterType.Virtual, ParameterType.Axis, ParameterType.Input or ParameterType.Measurement.

Array1dParameterErrorsReply#

Field Type Label Description
parameters Array1dParameterValue repeated Parameter values.
return_code system_monitor_common.ErrorCode Return code.

Array1dParameterSetValue#

Field Type Label Description
parameter_id string Id of the parameter.
values double repeated Values for the parameter array.

Array1dParameterValue#

Field Type Label Description
parameter_id string Id of the parameter.
values double repeated Values for the parameter array.
return_code system_monitor_common.ErrorCode Return code.

Array1dValueReply#

Field Type Label Description
values Array1dValues repeated 1d Array parameter values.
return_code system_monitor_common.ErrorCode Return code.

Array1dValues#

Field Type Label Description
parameter_id string Id of the parameter.
values double repeated Values for the parameter array.
return_code system_monitor_common.ErrorCode Return code.

Array2dParameterErrorsReply#

Field Type Label Description
parameters Array2dParameterValue repeated Parameter values.
return_code system_monitor_common.ErrorCode Return code.

Array2dParameterSetValue#

Field Type Label Description
parameter_id string Id of the parameter.
rows RowValues repeated Values for the parameter array.

Array2dParameterValue#

Field Type Label Description
parameter_id string Id of the parameter.
rows RowValues repeated Values for the parameter array.
return_code system_monitor_common.ErrorCode Return code.

Array2dValueReply#

Field Type Label Description
values Array2dValues repeated 2d Array parameter values.
return_code system_monitor_common.ErrorCode Return code.

Array2dValues#

Field Type Label Description
parameter_id string Id of the parameter.
rows RowValues repeated Values for the row.
return_code system_monitor_common.ErrorCode Return code.

AxisParametersReply#

Field Type Label Description
parameter_ids string repeated Parameter identifiers.
return_code system_monitor_common.ErrorCode Return code.

BitMaskReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
mask int32 Parameter bit mask.
return_code system_monitor_common.ErrorCode Return code.

BitShiftReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
shift int32 Parameter bit shift.
return_code system_monitor_common.ErrorCode Return code.

ByteOrderReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
byte_order system_monitor_common.ByteOrder Byte order.
return_code system_monitor_common.ErrorCode Return code.

CANParameterProperties#

Field Type Label Description
Id string The unique identifier of the CAN Parameter
name string The display name of the parameter
description string The description of the parameter
lower_display_limit double The minimum display value
upper_display_limit double The maximum display value
min_logging_rate uint32 The minimum logging rate
scaling_factor uint32 The parameter scaling factor (see see EScalingUnit).
min_not_defined bool State of the min/max values.
conversion_id string Unique identifier of the conversion rule used in this parameter.
rx bool Flag to indicate Rx / Tx status of the parameter
data_type system_monitor_common.DataType Parameter data type
can_bus string CAN Bus name.
can_message string CAN Message name.
can_start_bit uint32 CAN parameter start bit.
can_bit_length uint32 CAN parameter bit length.
can_gain double CAN parameter gain value.
can_offset double CAN parameter offset value.
can_mux_id string CAN parameter multiplexer id. Blank if parameter is not in a multiplexed message.
can_byte_order system_monitor_common.ByteOrder CAN parameter byte order.
return_code system_monitor_common.ErrorCode Return code.

CANParameterPropertiesReply#

Field Type Label Description
parameters CANParameterProperties repeated The CAN parameter properties.
return_code system_monitor_common.ErrorCode Return code.

Conversion#

Field Type Label Description
id string Id of the conversion.
type system_monitor_common.ConversionType Type of the conversion. - One of ConversionType.Rational, ConversionType.Table, ConversionType.Text or ConversionType.Formula.

ConversionListReply#

Field Type Label Description
conversions Conversion repeated The conversions.
return_code system_monitor_common.ErrorCode Return code.

ConversionNoAppRequest#

Field Type Label Description
conversion_id string Id of the conversion.

ConversionTypeReply#

Field Type Label Description
conversion_id string Id of the conversion.
type system_monitor_common.ConversionType
return_code system_monitor_common.ErrorCode Return code.

ExternalParameterRequest#

Field Type Label Description
parameter_id string Id of the parameter.

ExternalReply#

Field Type Label Description
parameter_id string Id of the parameter.
gain double Gain.
offset double Offset.
return_code system_monitor_common.ErrorCode Return code.

ExternalRequest#

Field Type Label Description
parameter_id string Id of the parameter.
gain double Gain.
offset double Offset.

FormulaConversionReply#

Field Type Label Description
conversion_id string Unique identifier of conversion.
comment string Human readable description.
format string Format string (e.g. %1.3f).
units string Unit value for output.
formula string Formula value.
inverse string Inverse value.
return_code system_monitor_common.ErrorCode Return code.

FormulaConversionRequest#

Field Type Label Description
conversion_id string Unique identifier of conversion.
comment string Human readable description.
format string Format string (e.g. %1.3f).
units string Unit value for output.
formula string Formula value.
inverse string Inverse value.
overwrite bool Specifies to overwrite existing values.

LoggableReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
loggable bool Whether the parameter is loggable.
return_code system_monitor_common.ErrorCode Return code.

MapPropertiesReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
x_axis_id string Identifier of the x axis parameter
y_axis_id string Identifier of the y axis parameter
x_points uint32 Number on breakpoints in the x axis.
y_points uint32 Number on breakpoints in the y axis.
return_code system_monitor_common.ErrorCode Return code.

OffsetReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
offset double Parameter offset.
return_code system_monitor_common.ErrorCode Return code.

OffsetRequest#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
offset double Parameter offset.

Parameter#

Field Type Label Description
id string Id of the parameter.
name string Name of the parameter.

ParameterErrorsReply#

Field Type Label Description
parameters ParameterValue repeated Parameter values
return_code system_monitor_common.ErrorCode Return code.

ParameterGroup#

Field Type Label Description
id string Id of the parameter group.
group string Name of the parameter group.

ParameterGroupsReply#

Field Type Label Description
parameters ParameterGroup repeated The parameter groups.
return_code system_monitor_common.ErrorCode Return code.

ParameterListReply#

Field Type Label Description
parameters Parameter repeated The parameters.
return_code system_monitor_common.ErrorCode Return code.

ParameterProperties#

Field Type Label Description
Id string Id of the parameter
name string Name of the parameter.
description string Description of the parameter.
type system_monitor_common.ParameterType Parameter data type. - One of ParameterType.scalar, ParameterType.axis_1, ParameterType.axis_2, ParameterType.array, ParameterType.string, ParameterType.Axis or ParameterType.Measurement.
units string Units of the parameter.
format string Format used to display the parameter's values.
conversion_id string Id of the conversion rule for the parameter.
groups string repeated Names of the groups the parameter belongs to.
data_type system_monitor_common.DataType Data type of the parameter.
data_size uint32 Size of the parameter data.
lower_engineering_limit double Lower engineering limit.
upper_engineering_limit double Upper engineering limit.
max_logging_rate uint32 Maximum logging rate.
prime bool Whether the parameter is marked as a Prime parameter.
read_only bool Whether the parameter is readonly.
tuneable bool Whether the parameter is tuneable.
multiplexed_ids string repeated Array of parameter multiplexer ids. Blank if parameter is not in a multiplexed message

ParameterPropertiesReply#

Field Type Label Description
parameters ParameterProperties repeated The parameter properties.
return_code system_monitor_common.ErrorCode Return code.

ParameterSetValue#

Field Type Label Description
parameter_id string Id of the parameter.
value double Value of the parameter.

ParameterTypeRequest#

Field Type Label Description
app_id uint32 Id of the application
parameter_id string Id of the parameter.
data_type system_monitor_common.ParameterType Parameter data type. - One of ParameterType.scalar, ParameterType.axis_1, ParameterType.axis_2, ParameterType.array, ParameterType.string, ParameterType.Can, ParameterType.Virtual, ParameterType.Axis, ParameterType.Input or ParameterType.Measurement.

ParameterValue#

Field Type Label Description
parameter_id string Id of the parameter.
value double Value of the parameter.
return_code system_monitor_common.ErrorCode Return code.

ParametersReply#

Field Type Label Description
parameter_ids string repeated Ids of the parameters.
return_code system_monitor_common.ErrorCode Return code.

RationalConversionReply#

Field Type Label Description
conversion_id string Unique identifier of conversion.
coefficient1 double Coefficient value 1.
coefficient2 double Coefficient value 2.
coefficient3 double Coefficient value 3.
coefficient4 double Coefficient value 4.
coefficient5 double Coefficient value 5.
coefficient6 double Coefficient value 6.
comment string Human readable description.
format string Format string (e.g. %1.3f).
units string Unit value for output.
default string Default value.
return_code system_monitor_common.ErrorCode Return code.

RationalConversionRequest#

Field Type Label Description
conversion_id string Unique identifier of conversion.
coefficient1 double Coefficient value 1.
coefficient2 double Coefficient value 2.
coefficient3 double Coefficient value 3.
coefficient4 double Coefficient value 4.
coefficient5 double Coefficient value 5.
coefficient6 double Coefficient value 6.
comment string Human readable description.
format string Format string (e.g. %1.3f).
units string Unit value for output.
default string Default value.
overwrite bool Specifies to overwrite existing values.

RowDetailsReply#

Field Type Label Description
row_id uint32 Row identifier
ident_offset int32 Parameter ident offset
return_code system_monitor_common.ErrorCode Return code.

RowValues#

Field Type Label Description
values double repeated Values for the row.

StringParameterErrorsReply#

Field Type Label Description
parameters StringParameterValue repeated Parameter values.
return_code system_monitor_common.ErrorCode Return code.

StringParameterSetValue#

Field Type Label Description
parameter_id string Id of the parameter.
value string Value of the parameter.

StringParameterValue#

Field Type Label Description
parameter_id string Id of the parameter.
value string Value of the parameter.
return_code system_monitor_common.ErrorCode Return code.

StringValueReply#

Field Type Label Description
values StringParameterValue repeated String parameter values.
return_code system_monitor_common.ErrorCode Return code.

TableConversion#

Field Type Label Description
raw double Raw numeric value.
mapped double Mapped numeric value.

TableConversionReply#

Field Type Label Description
conversion_id string Unique identifier of conversion.
comment string Human readable description.
format string Format string (e.g. %1.3f).
units string Unit value for output.
default string Default value.
interpolate bool Specifies interpolation on or off.
values TableConversion repeated Table conversion values.
return_code system_monitor_common.ErrorCode Return code.

TableConversionRequest#

Field Type Label Description
conversion_id string Unique identifier of conversion.
comment string Human readable description.
format string Format string (e.g. %1.3f).
units string Unit value for output.
default string Default value.
interpolate bool Specifies interpolation on or off.
values TableConversion repeated
overwrite bool Specifies to overwrite existing values.

TextConversion#

Field Type Label Description
raw double Raw numeric value.
mapped string Mapped text value.

TextConversionReply#

Field Type Label Description
conversion_id string Unique identifier of conversion.
format string Format string (e.g. %1.3f).
units string Unit value for output.
default string Default value.
values TextConversion repeated Text conversion values.
return_code system_monitor_common.ErrorCode Return code.

TextConversionRequest#

Field Type Label Description
conversion_id string Unique identifier of conversion.
format string Format string (e.g. %1.3f).
units string Unit value for output.
default string Default value.
values TextConversion repeated Text conversion values.
overwrite bool Specifies to overwrite existing values.

UndoRequest#

Field Type Label Description
buffer_type system_monitor_common.BufferType Buffer type.

ValueReply#

Field Type Label Description
values ParameterValue repeated Numeric parameter values.
return_code system_monitor_common.ErrorCode Return code.

WarningLimitsReply#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
low double Lower limit.
high double Upper limit.
return_code system_monitor_common.ErrorCode Return code.

WarningLimitsRequest#

Field Type Label Description
app_id uint32 Id of the application.
parameter_id string Id of the parameter.
low double Lower limit.
high double Upper limit.

SystemMonitorParameter#

Method Name Request Type Response Type Description
GetParameters AppTypeRequest ParameterListReply Gets parameters. AppId not required for CAN and Virtual parameters
GetConversions .system_monitor_common.AppRequest ConversionListReply Gets parameter conversion rules.
GetParameterAndGroups .system_monitor_common.AppRequest ParameterGroupsReply Gets parameters and groups
GetParameterProperties AppTypeRequest ParameterPropertiesReply Gets parameter properties
GetCANParameterProperties .system_monitor_common.ParametersRequest CANParameterPropertiesReply Gets CAN Parameter properties.
GetMapProperties .system_monitor_common.ParameterRequest MapPropertiesReply Gets map properties.
GetRowDetails .system_monitor_common.ParameterRequest RowDetailsReply Gets row details.
GetParameterBitMask .system_monitor_common.ParameterRequest BitMaskReply Gets a parameter bit mask.
GetParameterBitShift .system_monitor_common.ParameterRequest BitShiftReply Gets a parameter bit shift.
GetParameterAddress ParameterTypeRequest AddressReply Gets a parameter address.
GetParameterByteOrder .system_monitor_common.ParameterRequest ByteOrderReply Gets a parameter byte order value.
ParameterLoggable .system_monitor_common.ParameterRequest LoggableReply Gets whether a parameter is loggable.
GetExternalInputGainOffset ExternalParameterRequest ExternalReply Gets an input gain/offset for an external parameter.
SetExternalInputGainOffset ExternalRequest .system_monitor_common.Return Sets an input gain/offset for an external parameter.
GetModifiedParameters .system_monitor_common.AppRequest ParameterListReply Gets the modified parameters in a selected application
GetParameterWarningLimits .system_monitor_common.ParameterRequest WarningLimitsReply Gets the warning limits from a parameter.
SetParameterWarningLimits WarningLimitsRequest .system_monitor_common.Return Sets the warning limits for a parameter.
DeleteMinMax .google.protobuf.Empty .system_monitor_common.Return Deletes min/max values.
ExportInputSignals .system_monitor_common.FileRequest .system_monitor_common.Return Exports input signals to a file.
ImportInputSignals .system_monitor_common.FileRequest .system_monitor_common.Return Imports input signals from a file.
RegenerateInputSignalParameters .google.protobuf.Empty .system_monitor_common.Return Regenerate Input Signal parameters from RAW values.
UndoDataChanges UndoRequest .system_monitor_common.Return Reset all tune buffers on the unit and/or in the edit buffer.
RestoreValue .system_monitor_common.ParameterRequest .system_monitor_common.Return Restore a parameter value its to original saved value.
GetAxisParameterFromMap .system_monitor_common.ParameterRequest AxisParametersReply Retrieves a list of axis parameter(s) used by the map parameter in the application.
GetConversionUse .system_monitor_common.ConversionRequest ParametersReply Returns a list of all parameters using the specified conversion in the application.
GetConversionType ConversionNoAppRequest ConversionTypeReply Returns the type of the specified conversion rule.
GetRationalConversion ConversionNoAppRequest RationalConversionReply Retrieves a selected Rational Conversion
GetTableConversion ConversionNoAppRequest TableConversionReply Retrieve a specified Table Conversion rule.
GetTextConversion ConversionNoAppRequest TextConversionReply Retrieves enumeration values and text from conversion parameters.
GetFormulaConversion ConversionNoAppRequest FormulaConversionReply Retrieves a selected Formula (Free) Conversion
GetAppRationalConversion .system_monitor_common.ConversionRequest RationalConversionReply Retrieves the details from a Rational Conversion Rule.
GetAppTableConversion .system_monitor_common.ConversionRequest TableConversionReply Retrieve the details from a Table Conversion rule.
SetRationalConversion RationalConversionRequest .system_monitor_common.Return Create or modify a Rational Conversion rule.
SetTableConversion TableConversionRequest .system_monitor_common.Return Create or modify a Table Conversion rule.
SetTextConversion TextConversionRequest .system_monitor_common.Return Create or modify a text conversion rule.
SetFormulaConversion FormulaConversionRequest .system_monitor_common.Return Create or modify a Formula (Free) Conversion rule.
GetValueOffset .system_monitor_common.ParameterRequest OffsetReply Retrieve the live value offset for a parameter.
SetValueOffset OffsetRequest .system_monitor_common.Return Sets the live value offset for a parameter.
ZeroLiveValue .system_monitor_common.ParameterRequest .system_monitor_common.Return Zero's the live value by applying an offset to a measurement parameter.
GetValueMeasurement .system_monitor_common.AppParametersRequest ValueReply Returns the current value of a specified measurement parameter.
GetValueScalar .system_monitor_common.AppParametersRequest ValueReply Returns the current value of a specified scalar (VALUE) editable parameter.
GetValue1AxisMap .system_monitor_common.AppParametersRequest Array1dValueReply Returns the current values of a specified 1-axis map (CURVE) editable parameter at all axis points.
GetValue2AxisMap .system_monitor_common.AppParametersRequest Array2dValueReply Returns the current values of a specified 2-axis map (MAP) editable parameter at all axis points.
GetValueAxis .system_monitor_common.AppParametersRequest Array1dValueReply Returns the current values of a specified axis (AXIS_PTS) editable parameter at all axis points.
GetValueArray .system_monitor_common.AppParametersRequest Array1dValueReply Returns the current values of a specified array (VAL_BLK) editable (characteristic) parameter at all index positions.
GetValueString .system_monitor_common.AppParametersRequest StringValueReply Returns the current value of a specified string editable parameter
GetValueCAN .system_monitor_common.ParametersRequest ValueReply Retrieves the value of the specified can parameter.
GetValueVirtual .system_monitor_common.ParametersRequest ValueReply Retrieve a selected Virtual Parameter.
GetDTVValueScalar .system_monitor_common.ParametersFileRequest ValueReply Returns the value of a specified scalar (VALUE) editable parameter from the supplied DTV.
GetDTVValue1AxisMap .system_monitor_common.ParametersFileRequest Array1dValueReply Returns the values of a specified 1-axis map (CURVE) editable parameter at all axis points from the supplied DTV.
GetDTVValue2AxisMap .system_monitor_common.ParametersFileRequest Array2dValueReply Returns the values of a specified 2-axis map (MAP) editable parameter at all axis points from the supplied DTV.
GetDTVValueAxis .system_monitor_common.ParametersFileRequest Array1dValueReply Returns the values of a specified axis (AXIS_PTS) editable parameter at all axis points from the supplied DTV.
GetDTVValueArray .system_monitor_common.ParametersFileRequest Array1dValueReply Returns the values of a specified array (VAL_BLK) editable (characteristic) parameter at all index positions from the supplied DTV.
GetDTVValueString .system_monitor_common.ParametersFileRequest StringValueReply Returns the value of a specified string editable parameter from the supplied DTV.
SetValueScalar AppParameterValuesRequest ParameterErrorsReply Sets the current value of a specified scalar (VALUE) editable parameter.
SetValue1AxisMap AppArray1dParameterValuesRequest Array1dParameterErrorsReply Sets the current value of a specified 1-axis map (CURVE) editable parameter at one or more axis points.
SetValue2AxisMap AppArray2dParameterValuesRequest Array2dParameterErrorsReply Sets the current value of a specified 2-axis map (MAP) editable parameter at one or more axis points.
SetValueAxis AppArray1dParameterValuesRequest Array1dParameterErrorsReply Sets the current value of a specified axis (AXIS_PTS) editable parameter at one or more axis points.
SetValueArray AppArray1dParameterValuesRequest Array1dParameterErrorsReply Sets the current value of a specified array (VAL_BLK) parameter at one or more index positions.
SetValueString AppStringParameterValuesRequest StringParameterErrorsReply Sets the current value of a specified string editable parameter.

Top

Protos/system_monitor_project.proto#

ActiveAppReply#

Field Type Label Description
app_ids uint32 repeated Application ids
return_code system_monitor_common.ErrorCode Return code.

AppFileRequest#

Field Type Label Description
app_id uint32 Application id.
file_path string File path.

AppReply#

Field Type Label Description
text string Return text value.
return_code system_monitor_common.ErrorCode Return code.

Application#

Field Type Label Description
app_id uint32 Application Id.
app_name string Application name.
return_code system_monitor_common.ErrorCode Return code.

CANMergeRequest#

Field Type Label Description
index uint32 Bus Index.
file_path string Name and path of .csv.
merge bool Merge with existing messages.

CANRequest#

Field Type Label Description
index uint32 Bus Index
file_path string Name and path of CAN .csv file.

CompareAppReply#

Field Type Label Description
parameters CompareParameter repeated The compared parameter information.
return_code system_monitor_common.ErrorCode Return code.

CompareAppRequest#

Field Type Label Description
app_id uint32 Application id.
dtv1_path string Filename and full path of the first DTV to compare against (.dtv).
dtv2_path string Filename and full path of the second DTV to compare against (.dtv).

CompareParameter#

Field Type Label Description
parameter_id string Parameter id.
type system_monitor_common.ParameterType Parameter data type. - One of ParameterType.scalar, ParameterType.axis_1, ParameterType.axis_2, ParameterType.array, ParameterType.string, ParameterType.Can, ParameterType.Virtual, ParameterType.Axis, ParameterType.Input or ParameterType.Measurement.
reason1 ReasonCode Reason codes for difference between the parameter in the application in memory and the first DTV supplied.
reason2 ReasonCode Reason codes for difference between the parameter in the application in memory and the second DTV supplied.

DTVModifiedReply#

Field Type Label Description
modified bool Whether the DTV is modified.
return_code system_monitor_common.ErrorCode Return code.

DTVSaveCopyRequest#

Field Type Label Description
app_id uint32 Application Id.
save_path string Filename and full path.
comment string Prefix to existing comment.
notes string Prefix to existing notes.
consortium string Consortium name to save data version to. Consortium Id in the DTV will be saved with the supplied value if licence permissions allow, otherwise error code -2 is returned. Set to "Disabled" to remove team security and unlock file.

DTVSaveIncrementRequest#

Field Type Label Description
app_id uint32 Application Id.
comment string Prefix to existing comment.
notes string Prefix to existing notes.

DTVSaveRequest#

Field Type Label Description
app_id uint32 Application Id.
save_path string Filename and full path.
comment string Prefix to existing comment.
notes string Prefix to existing notes.

DTVSavedOnReply#

Field Type Label Description
saved_on string Timestamp the DTV was saved at.
return_code system_monitor_common.ErrorCode Return code.

DetailsRequest#

Field Type Label Description
app_id uint32 Application Id.
text string Data Version Notes or Comments

EnableRequest#

Field Type Label Description
enable bool True to enable, false to disable.

ErrorDefinition#

Field Type Label Description
id string Error definition id.
name string Error definition name.
description string Error definition description.
group string Error definition group.
bit_number uint32 Error definition bit number.
current string Error definition current parameter identifier.
logged string Error definition logged parameter identifier.

ErrorDefinitionsReply#

Field Type Label Description
error_definitions ErrorDefinition repeated The error definitions.
return_code system_monitor_common.ErrorCode Return code.

ErrorInstance#

Field Type Label Description
name string Error identifier.
description string Error description.
status system_monitor_common.ErrorStatus Error status level.

ErrorReply#

Field Type Label Description
error_instances ErrorInstance repeated The active errors
return_code system_monitor_common.ErrorCode Return code.

Event#

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

EventReply#

Field Type Label Description
event_id uint32 Event Id.
description string Event description.
conversion_id1 string Id of first event conversion.
conversion_id2 string Id of second event conversion.
conversion_id3 string Id of third event conversion.
priority system_monitor_common.EventPriority Event level. ( 0 - High, 1 - Medium, 2 - Low, 3 - Debug )
return_code system_monitor_common.ErrorCode Return code.

EventRequest#

Field Type Label Description
app_id uint32 Application id.
event_id uint32 Event id.

EventsReply#

Field Type Label Description
events Event repeated The events.
return_code system_monitor_common.ErrorCode Return code.

ExistsReply#

Field Type Label Description
exists bool True if exists, False if not
return_code system_monitor_common.ErrorCode Return code.

ExistsRequest#

Field Type Label Description
app_id uint32 Application Id.
parameter_id string Parameter Id.
data_type system_monitor_common.ParameterType Parameter data type. - One of ParameterType.scalar, ParameterType.axis_1, ParameterType.axis_2, ParameterType.array, ParameterType.string, ParameterType.Can, ParameterType.Virtual, ParameterType.Axis, ParameterType.Input or ParameterType.Measurement.
return_code system_monitor_common.ErrorCode Return code.

FileDetailsReply#

Field Type Label Description
saved_by string Name of the last user to save the file.
saved_on google.protobuf.Timestamp Date time of last file save.
comment string File comments.
notes string File notes.
build uint32 Build number of System Monitor used when saving file.
consortium string Name of the licence consortium used to save the file. Set for supported file types only ( .dtv, .rlc & .dtp ).
owner string Name of the licence owner used to create the file. Set for supported file types only ( .dtv, .rlc & .dtp ).
rda string RDA unlock list checksum for locked DTV's.Set for supported file types only ( .dtv ).
return_code system_monitor_common.ErrorCode Return code.

FileNameRequest#

Field Type Label Description
file_type system_monitor_common.FileType File name of requested type. - One of FileType.Project, FileType.Desktop, FileType.Virtuals, FileType.LoggingConfig or FileType.Can.
slot uint32 Slot index (1-8). Only required for FileType.LoggingConfig and FileType.Can

FileNewRequest#

Field Type Label Description
file_type system_monitor_common.FileType Type of file to create. - One of FileType.Virtuals, FileType.LoggingConfig or FileType.Can.
file_path string The path of the file to create.
save_existing bool Whether to save the existing file.
overwrite bool Whether to overwrite an existing file with the same path.

FileOpenRequest#

Field Type Label Description
file_type system_monitor_common.FileType The type of file to open. - One of FileType.Desktop, FileType.Virtuals, FileType.LoggingConfig or FileType.Can.
file_path string The path of the file to open.
slot uint32 Slot index. Only required when loading Logging and CAN configuration (1-8).
activate bool True to set active. Only required when loading Logging and CAN configuration (1-8).

FileReply#

Field Type Label Description
file_path string File path including folder.
return_code system_monitor_common.ErrorCode Return code.

FileSaveRequest#

Field Type Label Description
file_type system_monitor_common.FileType Type of file to save. - One of FileType.Desktop, FileType.Virtuals, FileType.LoggingConfig or FileType.Can.
file_path string The path of the file to save.
comment string File comments.
notes string File notes.
consortium string Name of the licence consortium used to save the file. Set for supported file types only ( .dtv, .rlc & .dtp ).
save_copy_as bool Whether to save a copy without affecting SM modified status.

GetAppDetailsReply#

Field Type Label Description
apps Application repeated Application details.
return_code system_monitor_common.ErrorCode Return code.

GetBuildNumberReply#

Field Type Label Description
build_number uint32 System Monitor build number.
return_code system_monitor_common.ErrorCode Return code.

GetVersionNumberReply#

Field Type Label Description
major_version uint32 Major revision.
minor_version uint32 Minor revision.
build_version uint32 Build number.
return_code system_monitor_common.ErrorCode Return code.

MatlabDTVRequest#

Field Type Label Description
dtv_path string Filename and full path of DTV file.
export_path string Filename and full path of exported file.
data_only bool True if only data is to be exported, false to export data and definitions.
data_types system_monitor_common.ParameterType repeated Parameter data types included in export. - One or more of ParameterType.scalar, ParameterType.axis_1, ParameterType.axis_2, ParameterType.array, ParameterType.string, ParameterType.Can, ParameterType.Virtual, ParameterType.Axis, ParameterType.Input or ParameterType.Measurement.

MatlabRequest#

Field Type Label Description
app_id uint32 Application Id.
export_path string Filename and full path.
data_only bool True if only data is to be exported, false to export data and definitions.
data_types system_monitor_common.ParameterType repeated Parameter data types included in export. - One or more of ParameterType.scalar, ParameterType.axis_1, ParameterType.axis_2, ParameterType.array, ParameterType.string, ParameterType.Can, ParameterType.Virtual, ParameterType.Axis, ParameterType.Input or ParameterType.Measurement.

MatlabSelectedRequest#

Field Type Label Description
app_id uint32 Application Id.
export_path string Filename and full path.
data_only bool True if only data is to be exported, false to export data and definitions.
parameter_ids string repeated Identifiers of the parameters to be exported

MultiAppReply#

Field Type Label Description
app_ids uint32 repeated Applications containing the specified parameter.
return_code system_monitor_common.ErrorCode

MultiAppRequest#

Field Type Label Description
app_ids uint32 repeated Application identifiers.

PGVIDReply#

Field Type Label Description
pgv_id uint32 Result program version ID.
return_code system_monitor_common.ErrorCode Return code.

ParameterIdRequest#

Field Type Label Description
parameter_id string Parameter identifier.

ProjectCloseRequest#

Field Type Label Description
action int32 Action to perform when unsaved documents encountered on closing project. 0 - Cancel Save. 1 - Save All. 2 - Save None.

ProjectCreateRequest#

Field Type Label Description
project_path string Project name to be created within the current multi-application base.
app_paths string repeated Array of PGV files to be included.
desktop_path string Name of desktop document to be created or included if file already exists.
virtuals_path string Optional name of virtual parameters document to be created or included if file already exists.
can_path string Optional name of CAN configuration document to be created or included if file already exists.
logging_config_path string Optional name of remote logging configuration document to be created or included if file already exists.

ProjectExportRequest#

Field Type Label Description
save_modified bool Flag to indicate if any unsaved files in the project should be saved before exporting.

ProjectImportRequest#

Field Type Label Description
project_path string SMX file containing project to be imported.
base string Optional Multi-Application base name for import. If blank, the current default base is used.

ProjectSaveAsRequest#

Field Type Label Description
project_name string Name of renamed project file.
save_all bool If TRUE then all modified files are saved. If FALSE then only the project file is saved.
comments string New project comments.
notes string New project notes.

ProjectSaveRequest#

Field Type Label Description
save_all bool If TRUE then all modified files are saved. If FALSE then only the project file is saved.

ReasonCode#

Field Type Label Description
reasons system_monitor_common.Reason repeated Reason codes.

ReprogramRequest#

Field Type Label Description
app_ids uint32 repeated An array of all app ids to reprogram.
force bool Whether to force a reprogram.

SensorRequest#

Field Type Label Description
app_id uint32 Application Id.
sensor string Sensor identifier.
serial_number int32 Serial number.

SlotActiveRequest#

Field Type Label Description
slot uint32 Slot index (1-8).
active bool TRUE to activate the slot.

SlotReply#

Field Type Label Description
active bool Slot is active.
return_code system_monitor_common.ErrorCode return code.

SlotRequest#

Field Type Label Description
slot uint32 Slot index (1-8).

SyncedReply#

Field Type Label Description
synced bool TRUE if the edit buffer is in sync with the ECU.
return_code system_monitor_common.ErrorCode Return code.

SystemMonitorProject#

Method Name Request Type Response Type Description
ProjectOpen .system_monitor_common.FileRequest .system_monitor_common.Return Opens a Project.
ProjectClose ProjectCloseRequest .system_monitor_common.Return Closes a Project.
ProjectCreate ProjectCreateRequest .system_monitor_common.Return Create a new project. If full path names are used, the path must lie within the current multi-application base.
ProjectSave ProjectSaveRequest .system_monitor_common.Return Saves the current project.
ProjectSaveAs ProjectSaveAsRequest .system_monitor_common.Return Saves the current project as a new project.
ProjectImport ProjectImportRequest .system_monitor_common.Return Imports the project from a .smx file.
ProjectExport ProjectExportRequest .system_monitor_common.Return Exports the project to a .smx file.
Reprogram ReprogramRequest .system_monitor_common.Return Reprograms the ECU.
DownloadDataChanges .system_monitor_common.AppRequest .system_monitor_common.Return Causes any modifications made to the System Monitor edit buffer to be downloaded to the ECU.
EditBufferSynced .system_monitor_common.AppRequest SyncedReply Identifies whether the edit buffer is in sync with the ECU.
UploadDataVersion .system_monitor_common.AppRequest .system_monitor_common.Return Uploads specified data version to the edit buffer.
GetVersionNumber .google.protobuf.Empty GetVersionNumberReply Gets the version information contained within the System Monitor executable.
GetPGVVersion .system_monitor_common.AppRequest AppReply Gets the filepath for the .pgv of an application by Application Id.
GetPGVID .system_monitor_common.AppRequest PGVIDReply Gets the program version ID of the currently loaded program version.
GetDTVVersion .system_monitor_common.AppRequest AppReply Returns the filename of the data version in the edit buffer.
GetEcuDTVVersion .system_monitor_common.AppRequest AppReply Returns the filename of the data version on the ECU.
GetNextDTVVersion .system_monitor_common.AppRequest AppReply Returns the filename of the next data version that will be saved if the user selects, File, Save. If the edit buffer is unmodified, this will be the name of the current data version in the edit buffer.
GetDTVModified .system_monitor_common.AppRequest DTVModifiedReply Gets the modified state associated with the DTV.
GetDTVSavedOn .system_monitor_common.AppRequest DTVSavedOnReply Gets the contents of the saved on attribute associated with the DTV.
GetDTVNotes .system_monitor_common.AppRequest AppReply Returns the contents of the notes attribute associated with the DTV.
SetDTVNotes DetailsRequest .system_monitor_common.Return Sets the Data Version notes for the specified application.
ClearDTVNotes .system_monitor_common.AppRequest .system_monitor_common.Return Clears the contents of the notes attribute associated with the DTV.
GetDTVComment .system_monitor_common.AppRequest AppReply Gets the contents of the comments attribute associated with the DTV.
SetDTVComment DetailsRequest .system_monitor_common.Return Sets the Data Version comment for the specified application.
EnableDTVBackup EnableRequest .system_monitor_common.Return Enables/Disables the data version backup during parameter value changes. Adds a message to the log file to indicate when changed. NOTE: Any changes to the data version whilst backups are suspended are not flushed to the backup file when the backups are re- enabled.
DTVOpen .system_monitor_common.FileRequest .system_monitor_common.Return Opens the specified data version file.
DTVSave DTVSaveRequest .system_monitor_common.Return Saves the current data version to the specified file.
DTVSaveCopy DTVSaveCopyRequest .system_monitor_common.Return Saves the current data version to the specified file, without modifying the data version in the edit buffer.
DTVSaveIncrement DTVSaveIncrementRequest .system_monitor_common.Return Increments the version number of the data version and then performs a save.
GetBuildNumber .google.protobuf.Empty GetBuildNumberReply Gets the build number of System Monitor (SM-V7). Client code may be branched on the basis of build number, thereby providing a way by which a single client script can be written which works with releases of SM-V7 which have different ActiveX interfaces.
GetAppDetails .google.protobuf.Empty GetAppDetailsReply Gets details of the applications in the current project.
GetActiveApps .google.protobuf.Empty ActiveAppReply Gets details of all the active applications.
SetActiveApps MultiAppRequest .system_monitor_common.Return Sets the active application when provided with an application ID.
AddApp .system_monitor_common.FileRequest .system_monitor_common.Return Adds the application defined by the given DTV and it's associated PGV into the project. If the application already exists in the project the error: SMAPI_ERR_INVALID_CMD (-31) will be returned.
RemoveApp .system_monitor_common.AppRequest .system_monitor_common.Return Removes the given application from the project. The requested application cannot be the BIOS.
CompareApp CompareAppRequest CompareAppReply Perform a compare between an application loaded in memory and up to two DTV's. When two DTV's are used both must have the same PGV version. Returns a list of parameters that contain differences along with the parameter data type and a reason code identifying the difference.
GetAppPULFile .system_monitor_common.AppRequest FileReply Get the name of the unlock list PUL file for the given application id.
SetAppPULFile AppFileRequest .system_monitor_common.Return Set the unlock list PUL file on the given application id. Licence ownership restrictions apply
GenerateParamSet .system_monitor_common.ParametersFileRequest .system_monitor_common.Return Generate a parameter set file.
GeneratePULFile .system_monitor_common.AppParametersFileRequest .system_monitor_common.Return Generate a PUL file for an application for use with Reduced Data Access. NOTE: On creation of PUL file the name will be adjusted from the requested name by including the checksum. This is required to reduce file lookup times.
GeneratePULFileFromParamSet AppFileRequest FileReply Generate a PUL file for an application for use with Reduced Data Access from a saved Parameter Set file. NOTE: On creation of PUL file the name will be adjusted from the requested name by including the checksum. This is required to reduce file lookup times. The adjusted file name will be returned in pszFileName.
ChangeSensorSerialNumber SensorRequest .system_monitor_common.Return Changes the serial number of the specified sensor.
FileOpen FileOpenRequest .system_monitor_common.Return Opens a file within System Monitor. Supports FileType.Desktop, FileType.LoggingConfig, FileType.Virtuals, FileType.Can.
FileSave FileSaveRequest .system_monitor_common.Return Saves a file within System Monitor. Supports FileType.Desktop, FileType.LoggingConfig, FileType.Virtuals, FileType.Can.
FileNew FileNewRequest .system_monitor_common.Return Creates a file within System Monitor. Supports FileType.LoggingConfig, FileType.Virtuals, FileType.Can.
GetFileName FileNameRequest FileReply Gets the name of a file from System Monitor. Supports FileType.Project, FileType.Desktop, FileType.LoggingConfig, FileType.Virtuals, FileType.Can
GetFileDetails .system_monitor_common.FileRequest FileDetailsReply Gets the file details for any file type supported by System Monitor.
CreateFFCFromPGV .system_monitor_common.FileRequest .system_monitor_common.Return Create an FFC File from the given PGV. Enable FFC advanced option must be set to 'Y' and full path name of PGV is required. FFC file will be created in same location as original PGV.
ExportToHexFile .system_monitor_common.AppRequest .system_monitor_common.Return Exports the selected applications PGV and DTV to a hexfile.
GetActiveCANConfig SlotRequest SlotReply Gets the active status of the CAN configuration in the given slot.
SetActiveCANConfig SlotActiveRequest .system_monitor_common.Return Set the active status of the CAN configuration in the given slot.
GetFIACANConfig SlotRequest SlotReply Gets the FIA status of the CAN configuration into the given slot.
SetFIACANConfig SlotActiveRequest .system_monitor_common.Return Set the FIA status of the CAN configuration into the given slot.
CANBuffersExport CANRequest .system_monitor_common.Return Exports the CAN Buffer configuration csv from the given CAN Bus index.
CANBuffersImport CANRequest .system_monitor_common.Return Imports the CAN Buffer configuration csv into the given CAN Bus index.
CANMessagesExport CANRequest .system_monitor_common.Return Exports the CAN Message configuration csv from the given CAN Bus index.
CANMessagesImport CANMergeRequest .system_monitor_common.Return Imports the CAN Message configuration csv into the given CAN Bus index.
CANConfigUnload SlotRequest .system_monitor_common.Return Unloads the CAN configuration from the given slot. (Slot index should be 2-8).
GetActiveLoggingConfig SlotRequest SlotReply Get the active status of the remote logging configuration in the given slot.
SetActiveLoggingConfig SlotActiveRequest .system_monitor_common.Return Set the active status of the remote logging configuration in the given slot.
LoggingConfigUnload SlotRequest .system_monitor_common.Return Unloads the remote logging configuration from the given slot.
MatlabImport .system_monitor_common.FileRequest .system_monitor_common.Return Imports the specified MatLab-M file into System Monitor.
MatlabExport MatlabRequest .system_monitor_common.Return Exports the currently loaded data version to the specified file in MatLab-M format.
MatlabExportDTV MatlabDTVRequest .system_monitor_common.Return Exports the specified data version to the specified file in MatLab-M format.
MatlabExportSelected MatlabSelectedRequest .system_monitor_common.Return Exports the specified list of editable parameters in Matlab format.
AddParametersToUnlockList .system_monitor_common.AppParametersFileRequest FileReply Update a PUL file for an application for use with Reduced Data Access by adding the requested parameter identifiers. NOTE: The PUL file name will be adjusted by including the new checksum and returned.
RemoveParametersFromUnlockList .system_monitor_common.AppParametersFileRequest FileReply Update a PUL file for an application for use with Reduced Data Access by removing the requested parameter identifiers. NOTE: The PUL file the name will be adjusted by including the new checksum and returned.
GetAppsHoldingParam ParameterIdRequest MultiAppReply Gets the applications which contain the specified parameter.
GetAppsHoldingMeasurementParam ParameterIdRequest MultiAppReply Gets the applications which contain the specified measurement parameter.
GetAppsHoldingControlParam ParameterIdRequest MultiAppReply Returns the applications which contain the specified non measurement parameter.
ParameterExists ExistsRequest ExistsReply Identifies if a parameter of the given type exists.
RegisterEnhancedRowParameters .system_monitor_common.AppParametersRequest .system_monitor_common.Return Add parameters from application to the enhanced speed row data list.
ClearEnhancedRowParameters .system_monitor_common.AppRequest .system_monitor_common.Return Clear all parameters for given application from enhanced speed slow row data list.
RegisterCANEnhancedRowParameters .system_monitor_common.ParametersRequest .system_monitor_common.Return Add CAN parameters to the enhanced speed row data list.
RegisterVirtualEnhancedRowParameters .system_monitor_common.ParametersRequest .system_monitor_common.Return Add virtual parameters to the enhanced speed row data list. All parameters referenced by each virtual will be added to the list.
ActivateEnhancedRowParameters .google.protobuf.Empty .system_monitor_common.Return Activate current enhanced speed row data list.
DumpEvents .system_monitor_common.FileRequest .system_monitor_common.Return Dumps the contents of the Event window to a specified file.
DumpErrors .system_monitor_common.FileRequest .system_monitor_common.Return Any errors that are currently occurring are dumped to disk.
DumpRowData .system_monitor_common.FileRequest .system_monitor_common.Return Dumps the current values of all acquired measurement parameters to disk.
ClearEvents .google.protobuf.Empty .system_monitor_common.Return Clears the event window in SM-V7.
GetEvents .system_monitor_common.AppRequest EventsReply Gets the events defined for a given application.
GetEventDetails EventRequest EventReply Gets the details for a given event defined in an application.
GetErrorDefinitions .system_monitor_common.AppRequest ErrorDefinitionsReply Gets the error definitions for a given application.
GetErrors .google.protobuf.Empty ErrorReply Returns list of active errors.
DeleteErrors .google.protobuf.Empty .system_monitor_common.Return Clears the active errors.

Top

Protos/system_monitor_system.proto#

BatchModeRequest#

Field Type Label Description
mode bool Enter/leave batch mode, true or false respectively.

CreatePGVReply#

Field Type Label Description
pgv_file_path string Path to created PGV file.
dtv_file_path string Path to created DT file.
return_code system_monitor_common.ErrorCode Return code.

CreatePGVRequest#

Field Type Label Description
location string Path to location for output files.
asap2_file_path string Path to base ASAP2 project .a2l file.
hex_file_path string Path to hex definition .hex file.
controllers_file_path string Path to controllers definition .ini file.
errors_file_path string Optional path to errors definition .ini file.
events_file_path string Optional path to events definition .ini file.
adjustment_file_path string Optional path to pot board definition .ini file.
sensors_file_path string Optional path to sensors definition .ini file.
injector_file_path string Optional path to sensor injector definition .ini file.
sensor_enable_file_path string Optional path to sensor enable / disable definition .ini file.
live_auto_tune_file_path string Optional path to live auto tune definition .ini file.
comments string PGV Comments
notes string PGV Notes

DeviceProperties#

Field Type Label Description
comms_path string Device communications path.
device_name string Device name.
ip_address string Device ip address.
serial_number int32 Device serial number.

DevicePropertiesReply#

Field Type Label Description
devices DeviceProperties repeated Device information.
return_code system_monitor_common.ErrorCode Return code.

FolderReply#

Field Type Label Description
file_path string File path
return_code system_monitor_common.ErrorCode Return code.

LicenceDetailsReply#

Field Type Label Description
consortium string Licence Consortium.
owner string Licence Owner.
return_code system_monitor_common.ErrorCode Return code.

LiveLoggingReply#

Field Type Label Description
live_logging_state bool Whether Live Logging is enabled or disabled.
return_code system_monitor_common.ErrorCode Return code.

LiveLoggingRequest#

Field Type Label Description
state bool True to turn Live Logging on, false to turn Live Logging off.

LiveUpdateRequest#

Field Type Label Description
state bool True to enable live updates, false to disable
action uint32 Action performed on data mismatch: 0 - No Action. 1 - Upload data from unit into edit buffer. 2 - Download edit buffer into unit. (Live tunes in unit may be lost).

MultiApplicationBaseInfo#

Field Type Label Description
name string Name of the multi-application base.
path string Path of the multi-application base.
return_code system_monitor_common.ErrorCode Return code.

MultiApplicationBasesReply#

Field Type Label Description
info MultiApplicationBaseInfo repeated Multi-application base information.
return_code system_monitor_common.ErrorCode Return code.

MultiApplicationBasesRequest#

Field Type Label Description
base_name string Name of the multi-application base.

OnlineRequest#

Field Type Label Description
state bool True to turn the ECU online, false to turn the ECU off-line.

SendMessageReply#

Field Type Label Description
messages int32 repeated Sent messages.
return_code system_monitor_common.ErrorCode Return code.

SendMessageRequest#

Field Type Label Description
app_id uint32 Application Id. (indicates ECU in multiple-ECU systems).
timeout uint32 Message time out
retries uint32 How many times to try before returning an error
messages int32 repeated Messages to send.

StatusReply#

Field Type Label Description
link_status LinkStatus The link status
online bool Whether the unit is online.
live_update bool Whether live updates are enabled.
return_code system_monitor_common.ErrorCode Return code.

UnitByIndexRequest#

Field Type Label Description
index uint32 Index of unit based on the car/unit list (as returned by GetUnitList())

UnitByIndexTypeRequest#

Field Type Label Description
index uint32 Index of unit based on the car/unit list (as returned by GetUnitList())
primary bool Whether the connection is for the main car or spare car

UnitInfo#

Field Type Label Description
name string Unit name.
type string Unit type
ip_address string Unit IP Address
return_code system_monitor_common.ErrorCode Return code.

UnitListReply#

Field Type Label Description
info UnitInfo repeated Unit information.
return_code system_monitor_common.ErrorCode Return code.

UnitNameReply#

Field Type Label Description
name string Unit name.
return_code system_monitor_common.ErrorCode Return code.

LinkStatus#

Name Number Description
Link_OK 0 Link OK
Link_NOK 1 Link Not OK
Controller_Busy 2 Controller busy
In_Boot 3 Device in boot
Zone_1 4 Device in zone one
Zone_2 5 Device in zone two
Zone_3 6 Device in zone three
Bad_Response 7 Bad response
Invalid_Device 8 Invalid device
Unknown 65535 Unknown status

SystemMonitorSystem#

Method Name Request Type Response Type Description
GetStatus .google.protobuf.Empty StatusReply Gets the combined current status of online, live updates, link status and active app.
SetOnline OnlineRequest .system_monitor_common.Return Turns the ECU on or off-line.
SetLiveUpdate LiveUpdateRequest .system_monitor_common.Return Enables or disables the sending of live-updates to the ECU.
GetUnitList .google.protobuf.Empty UnitListReply Returns an array of cars/units defined in the carfile.ini (ie. the connections that appear in the connections dialog)
GetUnitName .google.protobuf.Empty UnitNameReply Returns the name of the current car/connection.
GetUnitByIndex UnitByIndexRequest UnitInfo Returns the index of the car/unit entry within the car/unit list (as returned by GetCarList()). Obtains connection name, type and IP address.
SetUnitByIndex UnitByIndexTypeRequest .system_monitor_common.Return Sets the car/unit connection based on the car/unit list (as returned by GetCarList())
GetMultiApplicationBases .google.protobuf.Empty MultiApplicationBasesReply Gets details of all defined Multi-Application Bases.
GetMultiApplicationBase .google.protobuf.Empty MultiApplicationBaseInfo Gets details of a specific Multi-Application Base.
SetMultiApplicationBase MultiApplicationBasesRequest .system_monitor_common.Return Sets details of a specific Multi-Application Base.
GetLicenceDetails .google.protobuf.Empty LicenceDetailsReply Get the active consortium name and licence owner.
GetDeviceProperties .google.protobuf.Empty DevicePropertiesReply Get the properties of connected devices from the project.
GetLiveLogging .google.protobuf.Empty LiveLoggingReply Returns whether the Live Logging is currently recording or not.
SetLiveLogging LiveLoggingRequest .system_monitor_common.Return Starts or stops Live Logging.
SetBatchMode BatchModeRequest .system_monitor_common.Return Call this to enter (or leave) batch mode. This is used when creating virtual parameters; entering batch mode before the creation of multiple Virtual Parameters and leaving batch mode afterwards. Using this method, all created/updated Virtual Parameters will only be available in System Monitor after leaving batch mode.
SendMessage SendMessageRequest SendMessageReply Sends a message to the ECU.
GetLogFolder .google.protobuf.Empty FolderReply Get the current log folder location.
GetPPOFileName .google.protobuf.Empty FolderReply Get the name of the PPO file in the project.
CreatePGV CreatePGVRequest CreatePGVReply Create a new PGV from ASAP2 definitions.

Top

Protos/system_monitor_virtual.proto#

AddGroupRequest#

Field Type Label Description
group_path string The path where the groups is to be added, e.g. \TopLevelGroup\SubGroup
name string The display name for the virtual parameter group.
description string Description of the virtual parameter group.
read_only bool If set to true, the virtual parameter group will be marked as a Read Only.

VirtualExportRequest#

Field Type Label Description
file_path string File path to export parameters into.
group string Group name to export. NULL for all virtual parameters.

VirtualGroupReply#

Field Type Label Description
name string Name of the virtual parameter group.
description string Description of the virtual parameter group.
read_only bool Whether the virtual parameter group is Read Only
return_code system_monitor_common.ErrorCode Return code

VirtualGroupRequest#

Field Type Label Description
group string Identifier of the group.

VirtualGroupsReply#

Field Type Label Description
ids string repeated Identifiers of the virtual parameters.
return_code system_monitor_common.ErrorCode Return code

VirtualParameter#

Field Type Label Description
id string Identifier of the virtual parameter.
return_code system_monitor_common.ErrorCode Return code

VirtualParameterDataTypeRequest#

Field Type Label Description
Id string The unique identification of the virtual parameter.
data_type system_monitor_common.DataType The data type.

VirtualParameterProperties#

Field Type Label Description
Id string Parameter identifier.
name string Parameter display names.
description string Parameter description.
lower_display_limit double Lower display limit.
upper_display_limit double Upper display limit.
min_logging_rate uint32 Minimum logging rate.
scaling_factor uint32 Parameter scaling factor (see EScalingUnit).
min_not_defined bool State of min/max values.
expression string Expression used to evaluate the virtual parameter.
units string Parameter units.
format string Parameter display format.
group string Parameter group name.
conversion_id string Unique identifier of the parameter conversion rule.
data_type system_monitor_common.DataType Parameter data type.
return_code system_monitor_common.ErrorCode Return code.

VirtualParameterPropertiesReply#

Field Type Label Description
parameters VirtualParameterProperties repeated The properties of the virtual parameters
return_code system_monitor_common.ErrorCode Return code

VirtualParameterRequest#

Field Type Label Description
id string The unique identifier of the virtual parameter.
name string The display name for the virtual parameter.
description string Description of the virtual parameter.
min_display double Minimum value for display range.
max_display double Maximum value for display range.
Min_logging_rate int32 Minimum logging rate.
scaling_factor int32 Scaling factor. See EScalingUnit in Enumeration Definitions
is_min_not_def bool If set to true, the virtual parameter will be marked as a Prime Parameter.
expression string The expression to evaluate in the virtual parameter.
conversion_id string The conversion rule identifier for converting the output value to appropriate unit values.
overwrite bool Overwrites existing data
units string Sets the overriding units in which to display the virtual parameter’s value.
format_override string Sets the overriding format in which to display the virtual parameter’s value.
group string The path of the group in which to add the virtual parameter, e.g. \TopLevelGroup\SubGroup
data_type system_monitor_common.DataType The data type.
lower_warning double Lower warning limit value.
upper_warning double Upper warning limit value.

VirtualReply#

Field Type Label Description
ids VirtualParameter repeated Identifiers of the virtual parameters.
return_code system_monitor_common.ErrorCode Return code

VirtualsRequest#

Field Type Label Description
ids string repeated Identifiers of the virtual parameters.

SystemMonitorVirtual#

Method Name Request Type Response Type Description
SetVirtualParameter VirtualParameterRequest .system_monitor_common.Return Modify or Create a Virtual Parameter.
GetVirtualParameterProperties .system_monitor_common.ParametersRequest VirtualParameterPropertiesReply Gets the properties of the given virtual parameters
RemoveVirtualParameters VirtualsRequest VirtualReply Removes virtual parameters.
RemoveAllVirtualParameters .google.protobuf.Empty .system_monitor_common.Return Removes all virtual parameters.
RemoveVirtualConversions VirtualsRequest VirtualReply Removes virtual parameter conversion rules.
RemoveAllVirtualConversions .google.protobuf.Empty .system_monitor_common.Return Removes all virtual parameter conversion rules.
GetVirtualParameterGroups .google.protobuf.Empty VirtualGroupsReply Gets the virtual parameter groups.
GetVirtualParameterGroup VirtualGroupRequest VirtualGroupReply Gets a virtual parameter group.
GetVirtualParametersInGroup VirtualGroupRequest VirtualGroupsReply Gets the virtual parameters within a group.
VirtualParametersExport VirtualExportRequest .system_monitor_common.Return Exports virtual parameters.
VirtualParametersImport .system_monitor_common.FileRequest .system_monitor_common.Return Imports virtual parameters.
AddVirtualParameterGroup AddGroupRequest .system_monitor_common.Return Adds a virtual parameter group.
RemoveVirtualParameterGroup VirtualGroupRequest .system_monitor_common.Return Removes a virtual parameter group.
RemoveAllVirtualParametersFromGroup VirtualGroupRequest .system_monitor_common.Return Removes all virtual parameters from a group.
SetVirtualParameterDataType VirtualParameterDataTypeRequest .system_monitor_common.Return Sets the data type of a virtual parameter.

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)