IEEE C37.118 Serial Port Scanner and Configuration Loader
This tool is designed to operate with GPA synchrophasor products, e.g., the openPDC, SIEGate or the openHistorian.
The AutoConfigPortScanner scans serial ports on a system testing for Phasor Measurement Unit (PMU) connections using the IEEE C37.118 protocol. Once a connection has been established, the tool will scan through a specified ID code set in order to receive a configuration frame from the device. Once a device connection has been detected and a configuration frame has been received, the tool will automatically configure a new connection to the device in the host GPA synchrophasor tool.
This tool is useful to automate configuration and setup of PMU devices connected serially in bulk. This can be the case when a utility has chosen a serial-based communications infrastructure where using serial over Ethernet hubs can add hundreds of serial ports to a system.
Usage with Command Line Parameters
AutoConfigPortScanner [options]
Options
| Short | Long | Description |
|---|---|---|
‑b |
‑‑BaudRate |
Defines the serial baud rate. Standard values: 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200, 128000, or 256000. |
‑d |
‑‑DataBits |
Defines the standard length of data bits per byte. Standard values: 5, 6, 7 or 8. |
‑p |
‑‑Parity |
Defines the parity-checking protocol. Value is one of: Even, Mark, None, Odd or Space. |
‑s |
‑‑StopBits |
Defines the standard number of stopbits per byte. Value is one of: None, One, OnePointFive or Two. |
‑t |
‑‑DtrEnable |
Defines boolean value, true or false, that enables the Data Terminal Ready (DTR) signal during serial communication. |
‑r |
‑‑RtsEnable |
Defines boolean value, true or false, indicating whether the Request to Send (RTS) signal is enabled during serial communication. |
‑x |
‑‑AutoScan |
Defines boolean value, true or false, indicating whether the tool should start scan automatically on start. (unpersisted, command line only setting) |
‑i |
‑‑AutoRemoveIDs |
Defines boolean value, true or false, indicating tool should auto-remove ID codes from list as they are completed. (unpersisted, command line only setting) |
‑a |
‑‑ControllingConnection |
Defines boolean value, true or false, indicating whether added device configuration should be set for a controlling (active) or listening (passive) connection. |
‑n |
‑‑ResponseTimeout |
Defines the maximum time, in milliseconds, to wait for a serial response. |
‑c |
‑‑ConfigFrameTimeout |
Defines the maximum time, in milliseconds, to wait for a configuration frame. |
‑w |
‑‑DisableDataDelay |
Defined the delay time, in milliseconds, to wait after sending the DisableRealTimeData command to a device. |
‑‑StartComPort |
Defines the starting COM port number for the scan. | |
‑‑EndComPort |
Defines the ending COM port number for the scan. | |
‑‑StartIDCode |
Defines the starting IEEE C37.118 ID code for the scan. | |
‑‑EndIDCode |
Defines the ending IEEE C37.118 ID code for the scan. |
Examples
- Scan serial ports using 9600 baud:
AutoConfigPortScanner -b=9600 - Scan on app start using COM ports 100 to 131:
AutoConfigPortScanner -x=true --StartComPort=100 --EndComPort=131
Default Settings File
Default settings for optional parameters, e.g., serial baud rate and parity, are configured in a settings.ini file. This file will be automatically created when the application is first run. The location for this configuration file is C:\ProgramData\AutoConfigPortScanner\settings.ini.
The original default values are initially commented out. Following is an example of the default settings file with an override:
[Serial]
; Defines the serial baud rate. Standard values: 110, 300, 600, 1200, 2400,
; 4800, 9600, 14400, 19200, 38400, 57600, 115200, 128000, or 256000.
;BaudRate=115200
BaudRate=9600
; Defines the standard length of data bits per byte. Standard values: 5, 6,
; 7 or 8.
;DataBits=8
; Defines the parity-checking protocol. Value is one of: Even, Mark, None, Odd
; or Space.
;Parity=None
; Defines the standard number of stopbits per byte. Value is one of: None, One,
; OnePointFive or Two.
;StopBits=One
; Defines the value that enables the Data Terminal Ready (DTR) signal during
; serial communication.
;DtrEnable=False
; Defines the value indicating whether the Request to Send (RTS) signal is
; enabled during serial communication.
;RtsEnable=False
