LXMF Fields

This page is under heavy construction. -- Even official fields are considered experimental

Official

(1) Embedded LXMs

Constant	Index	Description	Content
FIELD_EMBEDDED_LXMS	0x01

Stub

(2) Telemetry

Constant	Index	Description	Content
FIELD_TELEMETRY	0x02	Node telemetry, all enabled sensors

(3) Telemetry Stream

Constant	Index	Description	Content
FIELD_TELEMETRY_STREAM	0x03	Aggregated downstream telemetry for bulk transfer

(4) Appearance

Constant	Index	Description	Content
LXMF.FIELD_ICON_APPEARANCE	0x04	Defines the icon that represents this node on the situation map.	[string ICON, byte[3] FG_COLOR, byte[3] BG_COLOR]

Icon is a string with the name of a Material Symbol. Searchable list

FG/BG Color is an RGB color code from 000000 to FFFFFF.

Python example: lxm.field[LXMF.FIELD_ICON_APPEARANCE]=["hiking",\xff\xff\x00,\x00\x00\xff] <- Displays a yellow hiker on a blue background

(5) File Attachment

Constant	Index	Description	Content
FIELD_FILE_ATTACHMENTS	0x05	Arbitrary file transfer field

(6) Image Attachment

Constant	Index	Description	Content
FIELD_IMAGE	0x06	Image container

(7) Audio Attachment

Constant	Index	Description	Content
FIELD_AUDIO	0x07	Audio container

(8) Thread

Constant	Index	Description	Content
FIELD_THREAD	0x08

(9) Commands

Constant	Index	Description	Content
FIELD_COMMANDS	0x09	Direct commands

Custom commands are sent in this field. Built in commands include: Ping Echo Signal

(A) Results

Constant	Index	Description	Content
FIELD_RESULTS	0x0A

(B) Group

Constant	Index	Description	Content
FIELD_GROUP	0x0B

Provisional