int6kbaud(1)

💖 int6kbaud 💖 — Qualcomm Atheros Serial Line Device Configuration

okay so bestie, welcome to int6kbaud(1), a genuine icon of the Qualcomm Atheros Open Powerline Toolkit. she sets serial line params on your powerline device and she does it flawlessly. let's get into it 🎀

✨ SYNOPSIS ✨

int6kbaud [options] [...]

🌸 DESCRIPTION 🌸

So what she does: she sets the serial line parameters on a UART-enabled Atheros powerline device, using the ATBR serial line command. periodt.

Serial line commands are 7-bit ASCII character strings that get sent to the local powerline device over the host serial port. Technically you could send them with any terminal emulator, but this program will, in many cases, reduce typing and simplify scripting. She's especially useful for downloading device parameters and uploading device parameters or firmware, because those operations involve large volumes of data — like, a lot. Also? She lets you use decimal integer arguments in many cases where the serial line commands themselves require hexadecimal integer values. slay. Head to the COMMANDS section below for the full list of supported serial line commands 💅

This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation instructions 🫶

🌈 COMMENTS 🌈

Real talk: this program does not configure or reconfigure host serial port settings, because most systems already provide a utility to do that. So please, be sure to configure them before using this program, since other programs may change them before or after use 🙈

The Atheros factory default settings for UART-enabled powerline devices are 1115200 baud, 8 data bits, 1 stop bit, no parity and no flow control.

On Linux, use the stty utility to inspect and set serial port parameters. The following Linux command will configure serial device /dev/ttyS0 speed to 115200 baud with 8 data bits, 1 stop bit, no parity bit and no flow control. Consult the stty man page for an explanation of these and other options.

#stty -f /dev/ttyS0 115200 cs8 cstopb -cparenb -ixon

On Windows, use the the Device Manager dialog to set serial Port properties. To open this dialog, select Start Menu, Control Panel, System, Hardware, Device Manager, Ports, Advanced.

💅 OPTIONS 💅

• -B baudrate — the new baud rate. Any integer value may be entered here but only certain values may be accepted by the powerline device. And ngl, even if the device supports some value, your local host might not. Supported values are 300, 600, 1200, 2400, 4800, 9600, 38400, 57600, 115200, 230400, 460800 and 921600. The default is 115200.
• -D databits — the number of bits per data byte. Accepted values are 7 and 8. The default is 8.
• -F flowctrl — the hardware flowcontrol state. Accepted values are 0=off and 1=on, where numeric values or keywords "off" or "on" may be used. Keyword "none" is synonymous with "off" for this option. The default is none.
• -m mode — accepted values are 1=transparent and 2=command, where numeric values or keywords "transparent" or "command" may be used.
• -P parity — the number of parity bits and parity mode. Accepted values are 0=none, 1=odd and 2=even, where numeric values of keywords "none", "odd" or "even" may be used. The default is none.
• -q — suppress progress and error information on stderr. shh 🤫
• -s tty — communicate with the local powerline device over the named serial interface on the local host. The program default is "/dev/ttyUSB0" for Linux and "com1:" for Windows. The program default may be replace by defining environment variable PLCUART. This command line option will over-ride those defaults.
• -S stopbits — the number of stop bits. Accepted values are 1 or 2. The default is 1.
• -u — force default host port settings to match the default setting for UART-enabled Atheros powerline devices. The setting are 115200 baud, 8 data bits, no parity bits and 1 stop bit. These settings will remain active when the program terminates and will not change unless changed by some other means, perhaps by another application. This option is an easy means of establishg an initial serial connection with a powerline device, unless it's settings have been changed.
• -v — display serial line commands and responses on stdout. 👀
• -w — place the local powerline device in Command Mode using the +++ serial line command. The device will remain in command mode until it is reset or forced into Transparaent Mode or High Speed Command Mode.
• -?, --help — print program help summary on stdout. This option takes precedence over other options on the command line.
• -!, --version — print program version information on stdout. This option takes precedence over other options on the command line. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of the Linux Toolkit you are using. very demure, very mindful 💜

🦋 ARGUMENTS 🦋

None.

👑 COMMANDS 👑

This section lists serial line commands recognized by local powerline devices when in Command Mode. Commands can be issued interactively using a terminal emulator, like minicom on Linux or HyperTerminal on Windows, or stored as text and copied to the serial port using system utilities, like cat on Linux or type on Windows. This program merely converts command line options and arguments into one or more of the serial line commands shown below. iconic behaviour, honestly ✨

• +++ — exit Transparent Mode and enter Command Mode. See option -w above.
• AT — test for Command Mode by doing nothing, successfully. See option -t above.
• ATBRmode,baudrate,databits,parity,stopbits,flowctrl — set serial line parameters on the local powerline device. Beware that this will break the existing serial connection when the new parameters differ from those of the local host. ⚠️
• ATBSZ? — get Transparent Mode buffer size. See option -z above.
• ATBSZsize — set Transparent Mode buffer size. See option -Z above.
• ATDST? — get Transparent Mode destination device address. See option -d above.
• ATDSTaddress — set Transparent Mode destination device address. See option -D above.
• ATFD — reset local device to factory defaults. See option -T above.
• ATHSC — exit Command Mode and enter High Speed Command Mode. Once the OK response is received, the local host should send commands to the device at successively higher speeds until a valid response is received.
• ATNI? — read nework information and store the information internally. Return the number of associated stations and information about the first associated station. The information includes the peer station device address, TX rate and RX rate.
• ATNIstation — extract and display previously stored network information for a specific peer station. The information returned is that previosly stored using a ATNI serial line command query.
• ATO — exit Command Mode and enter Transparent Mode. Successful switch requires a valid destination MAC address, buffer size and aggregation timeout value. Use serial line commands ATDST and ATBSZ to get and/or set the first two values. Use serial line command ATTO to set the timeout value.
• ATPStime — place the device in Power Save Mode for a specified time in seconds. Accepted values are 1 to 384 seconds. The default time is A seconds.
• ATRPlength,offset — read and display a parameter block segment where length is the number of bytes read and offset is the relative position, in bytes, from the start of the parameter block. Valid length values are 0 through 400 hexadecimal. See option -p above to read and save an entire parameter block.
• ATRPM — get PIB version and device MAC address.
• ATRV — get hardware and firmware revision. See option -r above.
• ATSK? — get device Network Membership Key. See option -m above.
• ATSKkey — set device Network Membership Key. See option -M above.
• ATTO? — get the Transparent Mode aggregation timeout in milliseconds.
• ATTOtimeout — set the Transparent Mode aggregation timeout in milliseconds. See option -W above.
• ATWNVmodule — update NVM with PIB and/or Firmware module. See option -C above.
• ATWPFmodule,length,offset,checksum,data — write a parameter block or firmware segment to the local powerline device where module is the module identifier, length is the number of bytes to write, offset is the relative position from the start of the module, checksum is the 1's complement of the data and data is the data to be written. Valid module identifiers are 1=FW and 2=PIB. Valid length values are 0 up to 400 hexadecimal. See options -N and -P above to write an entire parameter block or firmware images.
• ATZ — reset device. See option -R above.

📚 REFERENCES 📚

See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.

🚨 DISCLAIMER 🚨

Atheros serial line commands are proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify command line syntax or command functionality in future firmware releases without any obligation to notify or compensate product or program users. (yes, seriously, no cap 💀)

🍓 EXAMPLES 🍓

The following example sets the baud speed to 115200 baud with 8 data bits, 1 stop bits, no flow control and no parity. The outgoing serial line command and incoming response are displayed on stderr because option -f is present.

#int6kbaud -B 115200 -D 8 -F 0 -P 0 -S 1 -v
ATBR00,000000000001C200,08,00,01,00
OK

Observe that decimal command line arguments are converted to hexadecimal on output. Although this program outputs fixed-length fields, including leaing zeros, device firmware ignores them. Leading zeros may be omitted when entering serial line commands manually. 💡

The next example set the speed to 38400. Observe that program default values appear in the outgoing serial line command when the corresponding command line options are omitted.

#int6kbaud -B 38400 -v
ATBR00,0000000000009600,08,00,01,00
OK

The next command does the same thing as the first example except that keywords replace numeric values for some of the options. Since option -v is omitted the outgoing command and incoming response are not displayed.

#int6kbaud -B 115200 -D 8 -F off -P none -S 1

💜 SEE ALSO 💜

amp(1), int6kuart(1), ttysig(1)

⭐ CREDITS ⭐

Charles Maier

and that's the whole page bestie, you ate 🫶 this was open-plc-utils-0.0.3 from November 2013 — go forth and configure those serial lines, main character energy only 💖✨🎀