moxanix/README.md
2017-01-25 01:44:34 +01:00

1.7 KiB

Build Status

Moxanix

A serial device server, provides console access to multiple serial devices through telnet connection.

Architecture

The serial device server is broken down into multiple micro servers dedicated to a single serial device and TCP port pair.
These micro servers are then managed by a control script. The control script allows the user to start and stop these micro servers or check their status.
Connections between serial devices and TCP ports are configured in a separate file.
This design allows scalability and customization based on the number of available serial connections and TCP port availability.

moxerver

  • a light server application handling the session between one TCP port and one serial device
  • allows bidirectional communication
  • it is expected to run a separate instance for every serial device and TCP port pair

moxerverctl

  • starts, stops or displays status for different moxervers
  • commands can handle one specific or all moxervers at once

moxerver.cfg

  • defines connections between serial devices and TCP ports
  • each line corresponds to one micro server handling the defined connection

Build and install

Run make to build the project.
This default build will produce artifacts in a directory "install.dir" with executables installed in "usr/bin" (prefix is "usr").

You can install directly into some directory with make INSTALL_ROOT=/some/dir.
You can change the install prefix for executables with make BIN_PREFIX=someprefix.
These options can also be combined into make INSTALL_ROOT=/some/dir BIN_PREFIX=someprefix