UC Command — Custom User Reports

Allows creating custom reports by concatenating responses from multiple commands, plain text and calculated fields. Ideal for integrating specific data in tailored formats.

🎯 16 available reports (indices 00-0F), each fully configurable and independent.

What is it for?

Use case	Description
📊 Custom telemetry	Combine GPS data, sensors and states in a single report
🔗 Server integration	Specific format for tracking platforms
📝 Multi-sensor reports	Concatenate analog, digital and CAN readings
🏷️ Cargo identification	Include client/order codes from XB buffers
📋 JSON/CSV format	Structure data for APIs or processing

Commands

Operation	Syntax	Description
Configure	`SUCnn structure`	Define structure of report `nn`
Delete	`SUCnn*`	Remove configuration of report `nn`
Query	`QUCnn`	Read configured structure

Parameters

Parameter	Description	Values
`nn`	Report index	`00` to `0F` (16 reports)
`structure`	Field definition	Fields separated by `\|`

Response


RUCnn field1|field2|...|fieldN

Field Syntax

Basic

Command extraction


COMMAND,start,length

Element	Description
`COMMAND`	Command to execute (e.g: `QPQ`, `QIO`, `QCQ`)
`start`	First position to include (base 0)
`length`	Number of characters to extract

Example: QPQ,5,64 → Extract 64 characters from position 5 of QPQ response

With Split

Field with separator (split)


COMMAND,\XXnn,start,length

Element	Description
`\XX`	Separator in hexadecimal (e.g: `\2C` = `,`)
`nn`	Field number to extract (base 0)
`start`	Position within field
`length`	Characters to extract

Example: QXB00,\2C9,0,10 → From field 9 separated by commas, extract 10 chars

Text

Literal text


$text

Include plain text in the report.

Example: $TEMP: → Insert literally “TEMP:“

Event

Event identifier

Insert the event number that triggered the report (2 hex digits).

Example: If event 05 triggered the report, # is replaced by 05

No Comma

Without separator comma

Prefix command with space:


 COMMAND

Concatenate without adding comma between fields.

Special ASCII Characters

Use hexadecimal codes to insert special characters in the report.

Code	Character	Description
`\00`	NULL	Terminator
`\09`	TAB	Tabulation
`\0D`	CR	Carriage return
`\0A`	LF	Line feed
`\20`	SPACE	Space
`\2C`	`,`	Comma
`\3A`	`:`	Colon
`\3B`	`;`	Semicolon
`\5C`	`\`	Backslash
`\7C`	`\|`	Pipe

Inline EVAL Evaluation

Available since v1.9.18 — Report limit increased to 239 bytes.

Allows inserting EVAL expressions directly in the report using single quotes. Expressions are dynamically evaluated at send time.

Syntax


'expression'
'expression:format'
'expression:format:error_value'

Available Tokens

Token	Description
`'CHN'`	Communication channel name (WIFI, GPRS, etc.)
`'CHC'`	Channel code
`'CSQ'`	Cellular signal quality
`'VEL'`	GPS speed
`'LAT'`	Latitude
`'LON'`	Longitude
`'V'`	Main voltage
`'TICK'`	System tick

Functions

Function	Description
`'IN(x)'`	Digital input x
`'XP(x)'`	Digital output x
`'AIN(x)'`	Analog input x
`'TD(x)'`	Timer/Distance x
`'MBS(x,y)'`	BLE sensor (x=index, y=type)
`'MOD(a,b)'`	Modulo (remainder of a/b)

Text Operators

For comparisons within quotes, use text operators:

Operator	Equals	Example
`gt`	`>`	CSQ gt 15
`ge`	`>=`	V ge 120
`lt`	`<`	VEL lt 80
`le`	`<=`	AIN(0) le 500
`eq`	`==`	IN(0) eq 1
`ne`	`!=`	XP(0) ne 0

EVAL Inline Examples


 
// Report with channel, signal and speed formatted
>SUC00 $ID chanel:'CHN' signal:'CSQ:%02d' vel:'VEL:%d';#8002;ID=865413053386354;*61<
>RUC00 $ID chanel:'CHN' signal:'CSQ:%02d' vel:'VEL:%d';#8002;ID=865413053386354;*60<
 
>QU0;#8003;ID=865413053386354;*37<
>ID chanel:TRM signal:99 vel:0;#8003;ID=865413053386354;*03<

Maximum 20 EVAL tokens per report. Expressions are evaluated at send time, not at configuration.

Examples

Basic

Simple report with position


>SUC00 $POS| QPQ,5,64<

$POS → Literal text “POS”
QPQ,5,64 → QPQ response from position 5, 64 characters

Report with event identifier


>SUC03 $EVT| #| $\3B| QPQ,5,30<

The # is replaced by the triggering event number.

Multi-command

Report with multiple commands


>SUC01 $DATA| QCQ,5,20| $\3B| QIO,15,10<

$DATA → Prefix
QCQ,5,20 → Coordinates
$\3B → Separator ;
QIO,15,10 → I/O states

Report with separated field (split)


>SUC02 QXB00,\2C9,0,10<

Extract field 9 (separated by commas) from buffer XB00.

Formats

JSON-like format


>SUC0C ${"lat":| QCQ,5,10| $,"lon":| QCQ,15,11| $,"ign":| QIO,20,1| $}<

CSV format


>SUC0D QGP,5,14| $\2C| QCQ,5,10| $\2C| QCQ,15,11| $\2C| QIO,20,1<

UC Report Invocation

Manual query


>QU0<

Query the content of UC00 report.

Automatic generation with events


>SRL50E;TRG=IGN+;ACC={GU0}<

Generate UC00 report when ignition turns on.

To send the report to the server use GUn (Generator). QUn only queries locally.

Limitations

Parameter	Value
📦 Available UC reports	16 (00-0F)
📏 Maximum text length	239 bytes
🔢 Fields per report	~20 (depending on length)
🔢 EVAL inline tokens	20 maximum
🚫 Nestable commands	No (UC cannot contain UC)

Compatibility

💾Firmware:v1.00.00

C5Legacy

SP-IOT

SM-IOT

ZE-IOT

UC Command — Custom User Reports

What is it for?

Commands

Parameters

Response

Field Syntax

Basic

Command extraction

With Split

Field with separator (split)

Text

Literal text

Event

Event identifier

No Comma

Without separator comma

Special ASCII Characters

Inline EVAL Evaluation

Syntax

Available Tokens

Functions

Text Operators

EVAL Inline Examples

Examples

Basic

Simple report with position

Report with event identifier

Multi-command

Report with multiple commands

Report with separated field (split)

Formats

JSON-like format

CSV format

UC Report Invocation

Manual query

Automatic generation with events

Limitations

Compatibility

See Also