Logo ARIM Messaging Program v0.26 Help Logo

Introduction

ARIM means "Amateur Radio Instant Messaging" and the arim program is a host mode program for the ARDOP TNC being developed by Rick KN6KB and John G8BPQ.

A while ago I was involved in the development of the "US Edition" of the FSQCALL program. This was based on the source code released by FSQCALL developers Murray ZL1BPU and Con ZL2AFP. Among other features, it allowed the sending of short text messages to specific stations using a simple selective call feature. I saw a potential for "instant messaging" in this, so in the US Edition I tried to emphasize that use case with UI changes to make "messaging" more natural. However, the lack of Forward Error Correction (FEC) made me wish for something more.

When the ARDOP TNC project was announced by KN6KB I starting planning a host mode program that could take advantage of the connectionless FEC mode it offered. ARIM is the result. It is written in C and developed on Ubuntu Linux but should compile and run on any modern Linux installation (including Raspbian for Raspberry Pi). Using Microsoft Windows? No problem, Arim will build and run in the excellent Cygwin environment for Microsoft Windows. This lets you run arim on the same host as ARDOP_Win if you like. The only build dependency beyond the standard C libaries is the ncurses library. Arim is distributed as source code under the terms of the GPL v3.0 license. The goals of this project are:

The ARIM program is very much a work in progress and I am interested in feedback. I monitor the ARDOP Users group at groups.io and can be reached there, or at the arim-ham Yahoo group where files and other information will be posted.

The ARIM Screen Layout Color Coded Display Option Downloading and Installing
Configuration Rig Control/PTT Attaching to a TNC
Press 'h' for Help Press 'r' to toggle the Recents view Press 'p' to toggle the Ping History view
Press 'f' to set FEC mode and repeat count Scrolling back the Monitor View Change the Calls Heard timestamp format
Press <ESC> to abort send or receive Using the command line Sending commands to the TNC
Viewing and changing TNC settings Pinging another station Using Pilot Pings
ARQ: Connecting to a remote station ARQ: Sending queries to the remote station ARQ: Reading files from the remote station
ARQ: Downloading files from the remote station ARQ: Uploading files to the remote station FEC: Sending an unproto message
FEC: Sending a message (to TNC) FEC: Composing a message (to outbox) FEC: Working with the message inbox
FEC: Working with the message outbox FEC: Working with sent messages FEC: Reading messages
FEC: Querying another station for information FEC: Retrieving files from another station FEC: Using message send repeats
FEC: Beaconing Working with the files folder Reading files
Serving dynamic files Logging  

The ARIM Screen Layout

The ARIM screen is divided into different sections. Some of these can host more than one "view". The current view is identified by the title at the bottom of these sections.

ARIM

Color Coded Display Option

Color coding can be enabled by setting the color-code parameter in the [ui] section of the arim.ini file to TRUE (the default). When enabled, elements in the traffic monitor view, calls heard list and TNC command view are color coded to highlight the different frame/command types and group related traffic flows together.

ARIM

The traffic monitor view and TNC command view show very different types of information so different color coding schemes are used for each. The calls heard view is just a reflection of information in the traffic monitor view and uses the same color coding conventions.

Downloading and Installing

The prerequisite for arim is the ARDOP TNC. Two versions are available: ardopc for Linux and ARDOP_Win for the Windows.

Information about downloading and installing these is found here:

ardopc TNC for Linux Operating Systems

ARDOP_Win TNC (part of the ARDOP Chat installation) for Windows Operating Systems

To download the ARDOP Chat installer you must be a member of the ARDOP Users group at groups.io. The installer is found in the Files area of the group.

Next, you need to either build arim from source or download a precompiled binary package. To build from source, download the source code tarball:

Current ARIM Version 0.26 source and help file

To install extract the files into a directory of your choice: tar xzvf filename. This creates the arim directory containing source code files, a makefile, a model arim.ini file and two child directories: files for shared files and help containing this help file.

To build, cd into the arim directory and run make. You will need the gcc compiler and the ncurses development libraries and headers (ncurses-dev on Linux/Raspbian and libncurses-devel on Cygwin). See the INSTALL file included with the source code for more information.

To configure, open the arim.ini file in a text editor and edit as needed. You must define at least one TNC, by setting callsigns, grid square, TNC IP address and port number and name.

To run, cd into the arim directory and type ./arim.

If you prefer to install precompiled versions of arim, here are download links for 32 and 64-bit Ubuntu Linux (and derivatives like Linux Mint), Raspbian (on Raspberry Pi), and 32 and 64-bit Cygwin for Windows:

Current Version 0.26 binary and help file (32-bit Ubuntu Linux)

Current Version 0.26 binary and help file (64-bit Ubuntu Linux)

Current Version 0.26 binary and help file (Raspbian on Raspberry Pi)

Current Version 0.26 binary and help file (32-bit Cygwin on Windows)

Current Version 0.26 binary and help file (64-bit Cygwin on Windows)

If you plan to run arim in the Cygwin environment on Windows, then Cygwin must be installed first. The installer for Cygwin is found on the Installing and Updating Cygwin Packages page. The Cygwin Walkthrough and Beginner's Guide may be helpful in getting started.

When using Cygwin, you will work in the Cygwin Terminal. A shortcut to the Cygwin Terminal should be placed on your Windows desktop by the Cygwin installer.

To install, extract the files into a directory of your choice: tar xzvf filename. This creates the arim directory containing the executable file, a model arim.ini file and two child directories: files for shared files and help containing this help file.

To configure, open the arim.ini file in a text editor and edit as needed. You must define at least one TNC, by setting callsigns, grid square, TNC IP address and port number and name.

To run, cd into the arim directory and type ./arim.

Configuration

ARIM reads an "ini" format configuration file named arim.ini at startup. This file must be in the same directory as the arim executable file.

ARIM

Multiple TNCs can be defined. A subset of the ARDOP TNC parameters are initialized here, but these can be overridden from the TNC command line after the program starts. Most options have reasonable default values which are used if they are not found in the .ini file.

Rig Control/PTT

The ARIM program has no rig control features! It depends on the rig control features embedded in the ARDOP TNC.

I use VOX on my rig and it seems that Signalink cards work too. In both cases the VOX hold or SignaLink DLY must be set to minimum.

Attaching to a TNC

Make sure the ARDOP TNC is running. Press the spacebar to open the command prompt.

ARIM

Enter the att command, a space and the TNC number, e.g. att 1. The TCP connection will be made and initialization commands from the program to the TNC will scroll by in the TNC Command view. The title bar will display the number and name of the attached TNC.

To detach from the TNC, open the command prompt and enter the det command.

Press 'h' for Help

Press the 'h' hot key to open the Help contents in the monitor view area.

ARIM

Here is a listing of all hot keys and commands. Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll the contents. Press 'q' to quit.

Press 'r' to toggle the Recents view

Press the 'r' hot key to toggle on the Recents view in the TNC command view area.

ARIM

Here is a listing of headers for messages recently received. They are numbered in reverse chronological order (most recent first). The 4 digit hex number at the end of each line is the message checksum. Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll the contents. Press 'r' to toggle the Recents view off.

To read messages from the Recents list, press the spacebar to open the command prompt and enter the command rr nbr, where nbr is the message number. This opens the message viewer in the TNC command view area below.

ARIM

The message number and size in lines are shown in the Status Bar. Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll through the message. Press 'q' to quit the message viewer and return to the Recents view.

Press 'p' to toggle the Ping History view

Press the 'p' hot key to toggle on the Ping History view in the TNC command view area.

ARIM

Here is a listing of signal reports resulting from ARDOP pings sent to other stations by the TNC or from pings sent to the TNC by other stations. The history shows a line for each remote station, sorted in reverse chronological order (most recent on top). Each line includes, from left to right:

Press 't' to toggle the timestamp format between elapsed time or the UTC time (also affects the Calls Heard list timestamp format).

Press 'f' to set FEC mode and repeat count

Press the 'f' hot key to open the FEC Control Menu in the monitor view area.

ARIM

Press a key to select one of the options. All FEC modes are listed here, as well as options to set the FEC frame repeat count to either 0, 1, 2 or 3. Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll the menu contents. Press 'q' to quit. Note that these are ARDOP settings; the ARIM message repeat count found in the arim.ini file is a different thing. The ARDOP FEC repeat count affects all FEC transmissions by the TNC.

NOTE: In all views, the current FEC mode and repeat count are indicated in the status bar, to the left of the beacon time indicator. The format is fecmode:fecrepeat. In this example we see mode 4FSK.200.50 and a repeat count of 0 (the default).

Scrolling back the Monitor View

A 500 line scrollback buffer allows review of past traffic. Press the UP or DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME or END keys to start scrolling.

ARIM

The status bar is updated to indicate that scrolling is active. This state persists unless you stop using the movement keys for more than 30 seconds or press 'c' to cancel. Until then the view won't auto-scroll to the end when new traffic is posted.

Change the Calls Heard timestamp format

Press the 't' hot key to switch the Calls Heard list timestamp format between:

Press <ESC> to abort send or receive

Sometimes it's necessary to abort a transmission in progress or halt a receive operation instead of waiting for it to time out. To do this press the <ESC> key to cancel the operation and return ARIM to the idle state. When transmitting, this makes the TNC stop sending, flushes the transmit buffer, and cancels any pending message repeats. When receiving (or waiting for) an ARIM frame the time out counters are reset and any pending response is cancelled, making the TNC available for a new send operation immediately. A confirmation message will appear briefly on the Status Bar and the Busy/Idle indicator will reflect the change.

In ARQ mode, pressing the <ESC> key to abort a connection results in a "dirty disconnect". Use CTRL-X to attempt a clean disconnect before resorting to <ESC>.

Using the command line

Open the program and press the spacebar to open the command prompt.

ARIM

There are multiple uses for the command line.

Basic line editing features are available on the command prompt. The left and right arrow keys, HOME, END, DEL and backspace keys work as expected. This makes it easy to correct mistakes in typing, whether a entering a command or composing a message. For those familiar with the Emacs style line editing in Linux: CTRL-A, CTRL-E, CTRL-F, CTRL-B, CTRL-D, CTRL-K and CTRL-U can be used instead.

The command prompt has a history buffer which holds the last 15 unique commands entered. Use the UP and DOWN keys to browse command history when you want to reuse a previously sent command. For those familiar with Linux command history navigation, the CTRL-P and CTRL-N keys can be used instead.

Sending commands to the TNC

A TNC must be attached. Press the spacebar to open the command prompt.

ARIM

Prefix the message with the '!' character. Press ENTER to send the command to the TNC. The command trace will appear in the TNC command monitor view, followed by the TNC's response if it was a query. To set a TNC parameter, follow the command with the parameter, e.g. !CWID TRUE. To query a TNC parameter, send the command without any argument, e.g. !CWID. Complete control over the TNC is available using this interface. ARDOP TNC commands are documented in the Host Interface Spec for the ARDOP TNC by Rick Muething, KN6KB and available in the files area of the ARDOP users group at groups.io.

Viewing and changing TNC settings

TNC parameters are set in the [tnc] section of the arim.ini file and loaded when attaching to a TNC. However, some of these settings can be modified on-the-fly from the ARIM command prompt with these commands:

To change one of these, press the spacebar to open the command prompt and enter the command like this:

ARIM

The change will be confirmed by a message on the Status Bar. When in doubt, use the tncset command to check settings.

Pinging another station

A TNC must be attached. Press the spacebar to open the command prompt and enter the ping command like this:

ARIM

The format is ping call nbr. The ping repeat count must follow the target callsign. This is the number of times the PING packet will be sent in the absence of a response from the target station before the TNC "gives up". The minimum repeat count is 2 and the maximum is 15. Ping transmissions and responses are displayed in the monitor view. The reponse will include a signal report including the signal-to-noise ratio and a constellation quality figure ranging from 0-100%.

Using Pilot Pings

Pilot pings are an experimental option which take advantage of the new PING and PINGACK frame types introduced in ARDOP v0.9.5. The PINGACK response to a PING sent to a remote station includes a signal report with signal-to-noise and constellation quality numbers, making it possible for a station to learn how it is being heard by other stations.

Pilot pings are ARDOP PING frames automatically sent in advance of an ARIM message or query transmission or ARQ connect request to test the RF path to the target station. If the signal constellation quality report from the target station meets a preset threshold, the message transmission proceeds; if not then it is cancelled. This prevents hopeless attempts at message transmission from tying up the frequency in marginal conditions. The PING/PINGACK cycle is very short compared to the length of a typical FEC message transmission so the additional overhead is low, but the potential improvement in efficiency of channel use is high. Pilot pings are never sent in advance of ARIM messages directed to the net call. These parameters control pilot ping behavior:

These parameters are set in the [arim] section of the arim.ini file, but can also be modified on-the-fly from the ARIM command prompt so that the operator an adapt to changing conditions. Here are the commands you can use from the command prompt:

To change one of these, press the spacebar to open the command prompt and enter the command like this:

ARIM

The change will be confirmed by a message on the Status Bar. When in doubt, use the ppset command to check settings.

ARQ: Connecting to a remote station

ARIM can act as an ARQ client or server, interoperating with ARDOP Chat or another ARIM station for keyboard to keyboard chat. ARIM may also be used as an ARQ client to connect to a BPQ BBS with a ARDOP port.

A TNC must be attached. Press the spacebar to open the command prompt and enter the conn command like this:

ARIM

The format is conn call nbr. The ARQ request repeat count must follow the target callsign. This is the number of times the ARQCALL packet will be sent in the absence of a response from the target station before the TNC "gives up". The minimum repeat count is 2 and the maximum is 15. Connect requests and responses are displayed in the monitor view.

ARIM

When the connection is made, ARIM will be in ARQ mode, where text entered at the command prompt is sent directly to the remote station rather than processed as an ARIM command. The line editing and history recall features of the command prompt work as usual but the '!' prefix won't work to send commands directly to the TNC, and the ':' prefix won't work to send unproto FEC transmissions.

All text sent and received will be displayed on the Traffic Monitor, and the status bar will show the callsign of the remote station, the negotiated max connection bandwidth and the current TNC state. Note: the Recent Messages and Ping History views can't be opened during an ARQ session.

To disconnect, press CTRL-X or type the special command '/dis' at the command prompt and press ENTER.

ARIM

You'll be prompted to confirm:

ARIM

Type 'y' and a clean disconnect will be attempted.

ARIM

These parameters control ARQ behavior:

These parameters are set in the [tnc] section of the arim.ini file, but can also be modified on-the-fly from the ARIM command prompt by the operator. The following commands are available:

If pilot pings are enabled they will apply to ARQ connection requests, so that the RF path to the remote station can be tested in advance. If the pilot pings fail, the connection attempt will be cancelled.

ARQ: Sending queries to the remote station

If connected to an ARIM station, the following query commands, prefixed by the '/' (slash) character, may be entered at the prompt to retrieve information from the remote station:

Press the spacebar to open the command prompt and enter the command at the start of the line like this:

ARIM

Here we see the response:

ARIM

ARQ: Reading files from the remote station

If connected to an ARIM station files from the remote station's shared files folder can be read in the Traffic Monitor view. Only text files and dynamic files with text output can be printed to the screen. Use these commands to list available files and read them:

To list the files, press the spacebar to open the command prompt and enter the /flist command at the start of the line like this:

ARIM

The remote station responds:

ARIM

Choose a file, press the spacebar to open the command prompt and enter the /file fn command at the start of the line like this:

ARIM

The file will be read:

ARIM

The text is printed the the Traffic Monitor view line by line as it is received.

ARQ: Downloading files from the remote station

If connected to an ARIM station files can be downloaded from the remote station's shared files folder. Both text and binary file types can be transferred over the ARQ connection. This allows compressed file types, such as .zip files, to be used for more efficient transfers over HF links. Use these commands to list and download files:

To list files, press the spacebar to open the command prompt and enter the /flist command at the start of the line like this:

ARIM

The remote station responds:

ARIM

Choose a file, press the spacebar to open the command prompt and enter the /fget fn command at the start of the line like this:

ARIM

The download will begin:

ARIM

The progress of the download is reported as each data frame is received. When complete the file is saved into the download folder in the local shared files folder and an acknowledgement response sent to the remote station.

If the remote ARIM station encounters an error sending the file, an error response will be returned and the download cancelled.

While the download is in progress no text or commands are accepted from the command prompt. This condition is indicated by a ! character seen in the status bar indicator area:

ARIM

To cancel the download, press CTRL-X to close the ARQ connection.

ARQ: Uploading files to to the remote station

If connected to an ARIM station files can be uploaded to the remote station's download folder. Both text and binary file types can be transferred over the ARQ connection. This allows compressed file types, such as .zip files, to be used for more efficient transfers over HF links. Use this command to upload a file:

To upload a file, press the spacebar to open the command prompt and enter the /fput fn command at the start of the line like this:

ARIM

The upload will begin:

ARIM

The progress of the upload is reported as each data frame is sent. When complete an acknowledgement is received from the remote station to confirm that the file was saved.

If the remote ARIM station encounters an error receiving the file, an error message will be returned and the upload cancelled.

While the upload is in progress no text or commands are accepted from the command prompt. This condition is indicated by a ! character seen in the status bar indicator area:

ARIM

To cancel the upload, press CTRL-X to close the ARQ connection.

FEC: Sending an unproto message

A TNC must be attached. Press the spacebar to open the command prompt.

ARIM

Prefix the message with the ':' character. Press ENTER to send the message out over the air as raw ARDOP FEC frames, rather than being formatted as an ARIM message. The message will appear in the monitor view tagged with the [U] indicator.

FEC: Sending a message (to TNC)

When attached to a TNC, messages can be composed and sent immediately using the sm call [msg] command, where call is the callsign of the recipient and msg (optional) is optonal message text which may follow the callsign if the message is short and you wish to bypass the message composer to save time. To send a message without using the composer, press the spacebar to open the command prompt and enter the command like this:

ARIM

The message will be sent immediately after pressing the ENTER key to complete the command. For longer messages, press the spacebar to open the command prompt and enter the command like this:

ARIM

The message composer opens in the TNC command view.

ARIM

Enter the message line-by-line at the command prompt. When done, enter /ex at the start of a new line to close the message composer view and send the message on its way.

ARIM

The monitor view shows the outbound message and the inbound ACK from the recipient station.

To cancel a message enter /can at the start of a new line. This will discard the message and close the message composer view.

If the TNC is busy when the message is sent, the message will be stored in the outbox automatically. If the message send fails for some reason (NAK, ACK timeout, etc.) then this dialog will appear:

ARIM

Press 'y' to store the message to the outbox, 'n' to discard it. If you cancel the message send then this dialog will appear:

ARIM

Press 'y' to store the message to the outbox, 'n' to discard it.

FEC: Composing a message (to outbox)

Whether or not attached to a TNC, messages can be composed and stored in the message outbox using the cm call command where call is the callsign of the recipient. Press the spacebar to open the command prompt and enter the command like this:

ARIM

The message composer opens in the TNC command view.

ARIM

Enter the message line-by-line at the command prompt, then enter /ex at the start of a new line to close the message composer view and send the message to the outbox. To cancel a message enter /can at the start of a new line. This will discard the message and close the composer view.

FEC: Working with the message inbox

Press the spacebar to open the command prompt and enter the li command to open the message inbox viewer in the monitor view area.

ARIM

Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll through the message header list. Each message is given a number for use with commands. A list of available commands is printed in the Status Bar:

Press 'q' to quit the viewer.

FEC: Working with the message outbox

Press the spacebar to open the command prompt and enter the lo command to open the message outbox viewer in the monitor view area.

ARIM

Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll through the message header list. Each message is given a number for use with commands. A list of available commands is printed in the Status Bar:

Press 'q' to quit the viewer.

FEC: Working with sent messages

Press the spacebar to open the command prompt and enter the ls command to open the sent message viewer in the monitor view area.

ARIM

Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll through the message header list. Each message is given a number for use with commands. A list of available commands is printed in the Status Bar:

Press 'q' to quit the viewer.

FEC: Reading messages

When in the inbox or outbox viewer, press the spacebar to open the command prompt and enter the rm nbr command where nbr is the message number. This opens the message viewer in the TNC command view area below.

ARIM

The message number and size in lines are shown in the Status Bar. Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll through the message. Press 'q' to quit the message viewer and return to the message header view.

FEC: Query another station for information

A TNC must be attached. Press the spacebar to open the command prompt and enter the sq call query command where call is the callsign of the target station and query is one of these:

ARIM

The target station will send the requested information in a response message.

ARIM

The response message will appear in the monitor view tagged with the [R] indicator. It will be stored in the message inbox for later viewing, and also appear in the Recents list.

FEC: Retrieving files from another station

Use the sq call flist query to get a list of files from station call.

ARIM

The list will be returned in the response message which is stored into the inbox.

ARIM

To see it, open the message inbox view with the li command, then use the rm nbr command to read the file list message:

ARIM

Note the name of the file you wish to get. NOTE: Static files have their size in bytes listed with the file name. Dynamic files have the (d) label listed with the file name to indicate that their size is variable.

Press 'q' to close the message viewer and 'q' again to close the message inbox view.

Now use the sq call file fname command to query the file fname from station call. NOTE: file names are case sensitive!

ARIM

The file will be returned in the response message.

ARIM

The message is stored into the inbox where it can be viewed or saved to disk.

ARIM

NOTE: the maximum file size is set by the max-file-size parameter in the [arim] section of the arim.ini file. The file list returned by the flist query is filtered so that only static files less than the max size are listed, and the output of dynamic files is limited to the max size. At this time the absolute maximum allowed is 8192 bytes. The location of the ARIM files folder is set by the files-dir parameter in the [arim] section of the arim.ini file.

FEC: Using message send repeats

In difficult conditions it may be helpful to enable automatic repeats of messages if they are nak'd or an ACK timeout occurs. Three parameters control message send repeat behavior:

These parameters are set in the [arim] section of the arim.ini file, but can also be modified on-the-fly from the ARIM command prompt so that the operator an adapt to changing conditions. Here are the commands you can use from the command prompt:

To change one of these, press the spacebar to open the command prompt and enter the command like this:

ARIM

The change will be confirmed by a message on the Status Bar. When in doubt, use the srset command to check settings.

FEC: Beaconing

Beaconing can be configured for each TNC by the btime parameter in the relevant [tnc] section of the arim.ini file. This parameter defines the beacon interval time in minutes, with '0' meaning that beaconing is disabled.

When attached to a TNC, beaconing can be managed using the btime and btest commands. Use btime nbr to set the beacon interval to nbr minutes, and btest to test the beacon. The beacon status indicator in the Status Bar shows the interval time when beaconing is enabled, or "OFF" when disabled.

Working with the files folder

Press the spacebar to open the command prompt and enter the lf command to open the shared files folder viewer in the monitor view area.

ARIM

Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll through the shared files list. Each file is given a number for use with commands. A list of available commands is printed in the Status Bar:

Press 'q' to quit the viewer.

Reading files

When in the files folder viewer, press the spacebar to open the command prompt and enter the rm nbr command where nbr is the message number. This opens the file viewer in the TNC command view area below.

ARIM

The file name and size in lines are shown in the Status Bar. Use the UP and DOWN arrow keys or the PAGEUP, PAGEDOWN, HOME and END keys to scroll through the file. Press 'q' to quit the file viewer and return to the files folder view.

Serving dynamic files

Dynamic files are used to return output from a script or system command executed by ARIM in response to a file query.

Dynamic file aliases are listed in the output of the flist ARIM query. Because the size of the output is not known in advance, no file size is shown; instead the (d) identifier appears, like this:

ARIM

Here's a sample of the spwxfc dynamic file output as seen in an ARQ session:

ARIM

Dynamic file aliases are defined in the [arim] section of the arim.ini file. The format is alias:command where alias is the name used to access the file and command is the invocation of the command or script, separated by a : (colon) character. For example: dynamic-file = spwxfc:python ./scripts/forecast.py Make sure that alias is unique among the other dynamic file definitions and file names in the shared files folder. You may define no more than 16 dynamic files.

In response to the query sq file alias, command will be executed in a shell and its output returned in the response. command can be a batch file, a script invocation like python myscript or a system command like date or uname -a. The output size in bytes is limited by the max-file-size parameter in the [arim] section of the arim.ini file. Errors generated by dynamic file scripts are written to a file named dyn-file-error.log in the log folder.

Logging

Two logs can be enabled; the traffic log and the debug log. The traffic log is enabled by default and logs the content of all ARIM and ARDOP data frames sent and received by the TNC, with timestamping of each entry. The debug log is disabled by default. It logs all TNC commands sent and received by the ARIM program as well as exceptions encountered in operation like data wait timeouts, communication errors etc.

Set the traffic-log parameter in the [log] section of the arim.ini file to TRUE to enable traffic logging and to FALSE to disable it. Set the debug-log parameter in the [log] section of the arim.ini file to TRUE to enable debug logging and to FALSE to disable it.

Logs are kept in the logs subdirectory of the arim working directory. They are automatically rotated every 24 hours. The file name format is name-YYYYMMDD.log where name is either traffic or debug, followed by the date, e.g. traffic-20161114.log.

Copyright © 2016, 2017 by Robert Cunnings NW8L.  Last modified: 22 May 2017.