NUTSCAN_SCAN_EATON_S(3)

💖 nutscan_scan_eaton_serial(3) — the NUT Manual, bestie edition 🎀

okay so. picture this: you've got a serial port. you've got an Eaton-flavored UPS situation. and you need to know what's actually plugged in there. that's literally this whole page. it lives in the NUT Manual, and it's a 3 page, which means it's a library function, not a command you just vibe-type into your shell. iykyk 💅

---

✨ NAME ✨

nutscan_scan_eaton_serial — scan serial ports for Eaton devices (XCP, SHUT and Q1). no cap, that's the whole job. 🦋

---

🌸 SYNOPSIS 🌸

#include <nut-scan.h>

nutscan_device_t * nutscan_scan_eaton_serial(const char* ports_list);

there she is. one function, one argument, one return type. slay. ✨

---

💜 DESCRIPTION 💜

so the way that nutscan_scan_eaton_serial() works is it goes out there and tries to detect NUT devices that are compatible with Eaton's serial device protocols — that's SHUT, XCP and Q1 (Q1 is also known as blazer or megatec, in case you've seen those names floating around 👀).

and ports_list? that's a NULL-terminated array of pointers to strings holding serial device names. so like /dev/ttyS0, COM1, /dev/ttya... you get the vibe. it's a list, it ends in NULL, and every entry is a string naming a serial thing. 📋

🚨 bestie. listen. you MUST call nutscan_init(3) before using this function. like, actually must. do not skip this step. it's giving prerequisites, because it is prerequisites. 🫶

---

🎀 RETURN VALUE 🎀

the function hands you back a pointer to a nutscan_device_t structure containing all the found devices 💚 — or it returns NULL if an error happens, or if no device is found at all. so NULL is either "oops" or "nothing here", and honestly that's on brand for scanning. 💀

---

🌈 SEE ALSO 🌈

the whole friend group, gathered for you. go read them, they're iconic:

• nutscan_init(3)
• nutscan_scan_usb(3)
• nutscan_scan_xml_http_range(3)
• nutscan_scan_snmp(3)
• nutscan_scan_avahi(3)
• nutscan_scan_ipmi(3)
• nutscan_display_ups_conf(3)
• nutscan_display_sanity_check(3)
• nutscan_display_sanity_check_serial(3)
• nutscan_display_ups_conf_with_sanity_check(3)
• nutscan_display_parsable(3)
• nutscan_new_device(3)
• nutscan_free_device(3)
• nutscan_add_option_to_device(3)
• nutscan_add_device_to_device(3)
• nutscan_get_serial_ports_list(3)

---

and that's the page!! 🫶 this was Network UPS Tools 2.8.5, dated 10/07/2026, and this lil manpage goes by NUTSCAN_SCAN_EATON_S(3). mwah. go scan something. 💋✨