zack/moxa-image-uploader repository overview

⁠moxa-image-uploader

Provides an api to to work with the serial server. The server watches to see what devices are hooked up to the serial cables, and provides some apis to discover the devices hooked up. Most importantly it allows you to re-image a device based on serial number.

Available APIs

• GET /devices/:serialNumber
• GET /devices
• GET /ports
• GET /ports/:portName
• POST /image

⁠Configuration

The application comes with default ports configured. They are located in ./lib/portDefaults.js. The defaults are for a 4 port device. The ports are named Port1 through Port4.

• Port defaults
  • Serial server ip: 192.168.127.254
  • Port1: 4001
  • Port2: 4002
  • Port3: 4003
  • Port4: 4004

You can also configure the ports using environment variables. To get it to work you need to use at least two environment variables, i.e. SERVER_COUNT and SERVER_1. You can increase the SERVER_COUNT and add the corresponding SERVER_# environment variables to add additional servers. The SERVER_# is a comma separated list of arguments. The port names are prefixed with Server#. To mirror the default config you would use the following:

The SERVER_# comma separated arguments are:

1. Serial server ip
2. First port number
3. Number of total ports. It increases by 1 from the first port number through the total number of ports.

Some UC3100 devices have a bootloader that allows changing to which LAN port to use for TFTP. The default is to use LAN 1 port. You may update this for newer devices, with compatible bootloaders, by setting an environment variable. For example TFTP_PORT=2 will tell the uploader to set LAN2 as the port to do the TFTP transfer over.

SERVER_COUNT=1 SERVER_1="192.168.127.254,4001,4" npm start

This would result in the following config

• Generated ports
  • Serial server ip: 192.168.127.254
  • Server1Port1: 4001
  • Server1Port2: 4002
  • Server1Port3: 4003
  • Server1Port4: 4004

⁠Using docker

There is a Dockerfile available in this repo. You can use the docker image by running the following. You can remove --env DEBUG=* if you don't want it, and you change change the server count and port assignments as needed.

docker run -it --rm \
  --name moxa-image-uploader \
  -p 8080:8080 \
  --env DEBUG="*" \
  --env SERVER_COUNT="1" \
  --env SERVER_1="192.168.127.254,4001,4" \
  moxa-image-uploader

⁠image-uploader command

This npm package also comes with a utility image-uploader for uploading the image to one device.

If you want to upload the image example.img hosted by a TFTP server located at 192.168.116.1, the target device IP is 192.168.116.2, terminal server host is 192.168.127.254 and terminal server port is 4001.

The full command is below:

image-uploader --ts 192.168.116.1 --td 192.168.116.2 -s 192.168.115.254 -p 4001 -i example.img

⁠Usage

Options:
  --help                      Show help                                [boolean]
  --version                   Show version number                      [boolean]
  --tftp-server-ip, --ts      TFTP Server IP (where device download image from)
                                                                      [required]
  --tftp-device-ip, --td      TFTP Device IP (device IP address for TFTP)
                                                                      [required]
  --upload-image-timeout, -t  Upload image timeout in millsecond
                                                              [default: 1200000]
  --terminal-server-host, -s  Terminal server host  [default: "192.168.127.254"]
  --terminal-server-port, -p  Terminal server port               [default: 4001]
  --image, -i                 Image name                  [default: "image.img"]
  --continue, -c              Upload image for every new detected device
                                                                 [default: true]
  --verbose, -v                                                 [default: false]

⁠Development

git clone [email protected]:imZack/moxa-image-uploader.git
cd moxa-image-uploader
nvm use # (optional to use common node version)
npm install

You can start the server by running:

npm start

Make sure you lint new code before committing.

npm run lint

You can build the docker image by using

docker build -t moxa-image-uploader .

⁠Testing

The following node scripts and their descriptions

• test runs the unit tests.
• test:watch runs the unit tests with the watch flag min report and bails on the first failed test.