Net::C...:Serial(3pm)

📦
version 2.400002 · 6 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ NAME ✨

Net::CLI::Interact::Transport::Serial — it's giving serial-line based CLI connection, bestie 💖

🦋 DESCRIPTION 🦋

Okay so listen. This module hands you a wrapped instance of a Serial-line client, all cute and ready to go, specifically so that Net::CLI::Interact can use it. That's the whole gig. Slay. 💅

🌸 INTERFACE 🌸

🎀 app

On Windows platforms you must download the plink.exe program, and then pass its location to the library in this parameter. No plink.exe, no vibes, sorry bestie 😭

On other platforms, this defaults to cu — and yeah, you also have to download and install that one yourself. It's giving "bring your own tool" energy fr fr 🫶

🌈 runtime_options

So this one is built off the connect_options hash that gets handed to Net::CLI::Interact when it's constructed. It picks and formats the parameters that get passed along to app on the command line. Here's what's supported:

FIXME: on Windows platforms, only the device attribute is supported. 💀 (yes, that's a real note, we're just passing it along)
  • device (required) — the name of the device that's providing access to the Serial-line. Like, for example, "/dev/ttyUSB0" or "COM5". You literally cannot skip this one, it's the main character 👑
  • parity — you get a choice, bestie: "even", "odd" or "none" for the parity used in serial communication. The default is "none". Pick your fighter ✨
  • nostop — this controls whether you use "XON/XOFF" handling for the serial communication. The default is to have it disabled, so if you wanna turn it on, pass any True value. Simple as 🦋
  • speed — set the speed (or baud rate, same thing, iykyk) of the serial line by passing a value to this named parameter. The default is 9600. 🏃♀️💨
  • opts — got extra options you wanna pass to the application? Use this one. It should be an array reference, and each item in that list gets passed to the application, separated by a single space character. Very demure, very mindful 📋
  • reap — only used on Unix platforms, this installs a signal handler that attempts to reap the child process. Pass a true value to enable this feature only if you notice zombie processes are being left behind after use. Not me warning you about actual zombies 🧟♀️😭

👑 COMPOSITION 👑

For even more interface details, go check out:

  • Net::CLI::Interact::Transport::Base

perl v5.36.0 · 2023-10-28 — that's the version and date this little page came from, and honestly? iconic of it to be documented. Bye bestie, go reap those zombies 🫶💖✨

📦 where this page comes from