RESTMBMASTER.CONF(5)

✨ restmbmaster.conf — the config file that feeds your restmbmaster 💖

okay bestie, gather round, because this is the configuration file for restmbmaster, and honestly? it's giving effortless. iykyk.

---

🌸 NAME 🌸

restmbmaster.conf — the configuration file for restmbmaster, fr fr. this is section 5 of the manual, so you know it's about file formats, and yes, we're being fancy today 💅

---

🦋 DESCRIPTION 🦋

so the tea is: restmbmaster uses a very simple config file format. like, refreshingly simple. every single line looks like this:

key = value

and if an option doesn't take a value at all? no problem, the line is just:

key

that's it. that's the whole vibe. no YAML indentation drama, no TOML soul-searching, no XML. just vibes and equals signs. slay ✨

---

👑 OPTIONS 👑

okay here's the main character section. every option, no skips, we're not doing that here 💜

• debug — turns on debugging messages. and the way that you can just repeat the option to crank the verbosity up more? obsessed. more debug lines = more talking. 🗣️
• connect = CONNECT_URI — tells it which target Modbus bus to connect to. supported formats are below, and yes you have options, we love a flexible queen:
  • tcp://HOSTNAME[:PORT]

example: tcp://test.abc:1000

default PORT: 502

• rtu:DEVICEPATH[?baud=BAUDRATE]

example: rtu:/dev/ttyS0?baud=9600

default BAUDRATE: 115200

• port = PORT — the TCP port where the webserver is listening and where the Rest API gets exposed. this is literally where the magic gets served up 🍓
• dontkeep — don't keep the connection open. it only connects for the exact amount of time the command is being processed. no lingering, no hanging around, it's giving "we're not exclusive" 💀

---

🌈 EXAMPLES 🌈

Example Modbus TCP config:

connect = tcp://127.0.0.1:5020
port = 8080

Example Modbus RTU config:

connect = rtu:/dev/ttyUSB0?baud=9600
port = 8080

Example Modbus RTU config with debug messages verbosity:

connect = rtu:/dev/ttyUSB0?baud=9600
port = 8080
debug

see how the debug line just chills there with no =? that's the no-value format doing its thing. iconic behavior, honestly 🎀

---

🧚 SEE ALSO 🧚

• restmbmaster(8), — go read that one too, bestie, it's the whole point of all this 🫶

---

💖 AUTHOR 💖

Jiri Pirko is the original author and current maintainer of restmbmaster. we stan. 👑

---

lowkey reminder: this page is restmbmaster.conf, section 5, from the restmbmaster project — the date on this one is 2019-12-28. that's the source, the version vibe, and the date, all wrapped up in a cute little bow for you 🎀✨ love u, go configure something 💜