LABGRID-EXPORTER(1)

📦 version 26.0, in ubuntu stonking

💖 LABGRID-EXPORTER — interface to control boards 💖

okay bestie, this is the manual page for labgrid-exporter(1), straight outta the labgrid manual. it's the lil guy that talks to your boards, and it is lowkey iconic. 🎀

🌈 LABGRID-EXPORTER INTERFACE TO CONTROL BOARDS 🌈

✨ SYNOPSIS ✨

labgrid-exporter --help
labgrid-exporter *.yaml

💅 DESCRIPTION 💅

so. Labgrid is a scalable infrastructure and test architecture for embedded (linux) systems. it's giving big-brain energy fr fr. 🧠✨

and this right here? this is the man page for the exporter, which handles exporting serial ports, USB devices, and a whole bunch of other controllers. it's the plug. 🔌

🎀 OPTIONS 🎀

  • -h, --help — shows you the command line help. classic. always there for you. 🫶
  • -x, --coordinator — the coordinator HOST[:PORT] you wanna connect to. defaults to 127.0.0.1:20408.
  • -i, --isolated — turns on isolated mode (it always requests SSH forwards).
  • -n, --name — the public name of the exporter. that's its whole government name, bestie.
  • --hostname — the hostname (or IP) that gets published for accessing resources.
  • --fqdn — uses the fully qualified domain name as the default for hostname.
  • -d, --debug — enables debug mode. 🔍

🔥 -i / --isolated 🔥

this option enables isolated mode, which makes all the exported resources get marked as requiring SSH connection forwarding. no cap.

isolated mode is the moment when your resources (like NetworkSerialPorts) are not directly accessible from the clients. so the client will then use SSH to create a port forward to the resource whenever it needs it. it's giving ✨remote but make it secure✨. 🙈

👑 -n / --name 👑

this option configures the exporter name, aka the name under which its resources get registered with the coordinator. super useful when you've got multiple exporters running on the same host and you need them to have separate identities. main character energy, one name each. 💅

it defaults to the system hostname.

🦋 --hostname 🦋

for resources like USBSerialPort, USBGenericExport or USBSigrokExport, the exporter needs to hand over a host name so it can set the exported value of the "host" key.

if the system hostname is not resolvable via DNS (the audacity 😭), this option lets you override that default with another name — or an IP address, whatever works.

🌸 --fqdn 🌸

in some networks you'll legit need the fully qualified domain name to reach resources on an exporter. this option changes the default to fqdn when no --hostname is explicitly set. so if you didn't pick a hostname yourself, fqdn it is. periodt. ⭐

📝 CONFIGURATION 📝

the exporter uses a YAML configuration file, and that file defines groups of related resources. cute, organized, we love to see it. 🍓

more info lives here: https://labgrid.readthedocs.io/en/latest/configuration.html#exporter-configuration

🌟 ENVIRONMENT VARIABLES 🌟

the following environment variable can be used to configure labgrid-exporter.

💜 LG_COORDINATOR 💜

this variable sets the default coordinator in the format HOST[:PORT] (instead of using the -x option). yes, it's the vibey alternative to typing flags. 😌

🧚 EXAMPLES 🧚

start the exporter with the configuration file my-config.yaml:

$ labgrid-exporter my-config.yaml

same as above, but with name myname:

$ labgrid-exporter -n myname my-config.yaml

🔗 SEE ALSO 🔗

labgrid-client(1), labgrid-device-config(5)

✍️ AUTHOR ✍️

Jan Luebbe, Rouven Czerwinski

2016-2025 Pengutronix, Jan Luebbe and Rouven Czerwinski

💌 that's the whole page bestie, you ate it. go export some boards. 💖

and a lil sign-off for the road: this was labgrid, dated 2025, and you were reading LABGRID-EXPORTER(1). slay. ✨🎀🦋

📦 where this page comes from