Table of Contents
Cross-platform utility for SCOM enabled devices
Introduction
SCOMTOOL is a swiss-army-knife tool for all SCOM enabled devices. An SCOM enabled device is a device, that supports the SCOM serial communication protocol, developed at the AGH University of Science and Technology in Krakow, Poland and licensed to EMBETECH.
How to get it
SCOMTOOL is distributed in a binary form. Here are the links to the direct download:
scomtool.exe ver. 1.0 for Windows 64-bit
scomtool.deb ver. 1.0 for Debian/Ubuntu arch:amd64
General usage
SCOMTOOL is a command line tool. It works by communicating with external hardware, connected through a serial port (physical or virtual) to the PC. The usage is generally:
The following command line arguments are available:
Below is detailed explanation of all the usage possibilities
Printing help information
To get information about all possible command line arguments use the -h switch:
Printing version information
To get version information simply use the -v switch:
Running an automated scan on all available ports
The SCOMTOOL can run an automated check on all available serial ports, trying to identify SCOM enabled devices. It opens each available serial port and transmits a special SCOM packet (the so called IDENTIFY packet), that requests the device to identify itself. If a valid response is received, the port is considered to be active. Information about all SCOM enabled devices that has been found is then printed.
To run the automated scan use the -s switch:
Running the commands against all ports
The -s switch is also used to run other commands against all found devices.
Running against a specified port
In case when automated scan is not feasible, the SCOMTOOL can run against a particular device connected to a specified serial port. The -p switch is used for that purpose:
Resetting the SCOM device
Many times it is feasible to reset the SCOM enabled device prior to using it. The SCOMTOOL supports three ways to reset the device, covering typical embedded development scenarios:
- reset using the RTS line
- reset using the ST-link
- reset using the GPIO pin (only on platforms that support it)
To reset the SCOM device using the RTS line use the -r switch:
To reset the SCOM device using the ST-link use the -l switch:
The actual communication with the device may require additional delay after resetting. In such case use the -d switch, providing the time in milliseconds:
Specifying SCOM communication timeout
In rare cases it might be important to specify the communication timeout, that is the maximum time spent waiting for the response from the device. This time (in milliseconds) may be specified using the -o argument:
SCOM services
The functionality of SCOM devices is enclosed in so called SCOM services. Each SCOM device may support multiple SCOM services. The following services are currently defined:
- nameplate - allows to read out detailed information about the hardware and software
- firmware update - provides a method of in-application firmware update
- test run - allows to run unit test on the target platform
- etsi test - allows to run ETSI related radio tests
- configuration - allows to set application specific configuration
Running firmware update
The SCOMTOOL supports in-application firmware update through the use of SCOM Firmware Update service. The -u option allows to specify a file, that will be sent to the device as a firmware update. Typically, the device that that supports this service has a built in bootloader, that is invoked right after reset, so the procedure requires a reset. An exemplary command line that does exactly that is:
Running ETSI tests
The SCOMTOOL supports the ETSI test SCOM service, designed to assist in running RED/EMC related tests of a radio-capable device. The radio capabilities of the device are always printed during scan, if the given device supports this service.
Due to the complexity of the ETSI test service, to actually use it is necessary to prepare a JSON file, with the description of functionality you want to achieve, basing on the ETSI test service specification. The JSON script is passed then to the SCOMTOOL using the -f option like this:
Generated on Thu Aug 30 2018 22:25:19 for SCOMTOOL by 1.8.7