Abstract:
This document provides a description of the commands available in the Crimson 3.1 debug console.
Products:
CR Series HMI / Graphite® HMI / DA Series Data Station
Use Case:
Debugging Crimson databases.
Required Software:
Crimson® 3.1
Introduction
Debug commands have been exposed for user access by using a Debug Console communications driver or enabling the Debug Console on the Crimson 3.1+ Web Server. This document describes the helpful functions available to users.
Debug Console Communication Driver
In the Communications category in Crimson 3.1+ select the desired Ethernet or serial port then click on the Driver Selection Pick… button.
Select <System> Manufacturer and Debug Console driver as shown above.
In the case of the serial driver select the desired Port Settings to be matched in the terminal emulator.
When using the Ethernet port set the TCP/IP port and Terminal Mode to appropriate settings for the terminal emulator being used.
Web Server Debug Console
In the Crimson 3.1 Web Server, enable the Debug Console after enabling the System Pages in the Features tab as shown below.
Command List
The Debug Console reports available debug commands when entering help or diag.help at the prompt in the Debug Console.
Command Descriptions
cat
cat directory\filename
The cat command outputs the contents of the specified file on the current file system drive, prepending each line with the line number. Files must be less than 512K bytes. File content output is limited to the allowable viewing area of the debug window.
cd
cd directory
The cd command provides the user with the ability to change the current directory used for file system access.
cleargmc
cleargmc <no arguments>
Clears the currently reported GMC in the Red Lion device.
delete
delete directory\filename
Deletes the specified file.
dir
dir <no arguments>
Retrieves details on the currently active file system directory. Demonstrated below in conjunction with the cd command.
drive
drive singlechar
Changes the drive of the currently active file system to the drive specified by the single character argument.
hd
hd directory\file
hd offset count directory\file
The hd (HexDump) command will output the contents of the specified file in hexadecimal format. Alternatively, an offset and count in either decimal or hexadecimal form may be included in the argument list preceeding the file argument to only output a targeted range.
hello
hello <no arguments>
The Red Lion device will respond with a debug console title and the current time.
ls
ls <no arguments>
Retrieves details on the currently active file system directory. Demonstrated above in conjunction with the cd command.
ping
ping IPaddress
Performs a ping command on the IP address indicated and outputs the results. This ping command tests the ability of the Red Lion device to reach the specified IP address.
pwd
pwd <no arguments>
Outputs current file system access directory. Demonstrated above in conjunction with the cd and drive commands.
sntp
sntp <no arguments>
sntp IPaddress
Retrieves current time via SNTP. When sending this command without an SNTP server IP address argument, the system will attempt to retrieve the time via the SNTP configuration of the Time Manager in Crimson.
time
time <no arguments>
Reports current time and battery status.
traps
traps <no arguments>
Reports details on the trap history of the Red Lion device.
type
type directory\file
type offset count directory\file
The type command will output the contents of the specified file in textual format. Alternatively, a line offset and line count may be included in the argument list before the file argument to only output a targeted range. Files must be less than 512K in size.
uptime
uptime <no arguments>
Reports the current time and length of time since the last power cycle of the Red Lion device.
who
who <no arguments>
The who command outputs the Red Lion device identity.
buff.status
buff.status <no arguments>
Reports the usage of Ethernet data buffers in the Red Lion device.
comms.blocks
comms.blocks <no arguments>
Outputs statistics on internal communication blocks that reside in the current database on the Red Lion device.
comms.devices
comms.devices <no arguments>
Reports the current list of communications devices configured on the Red Lion device.
comms.ports
comms.ports <no arguments>
Reports communications port statistics of the Red Lion device.
eth0.all
eth0.all <no arguments>
Outputs all Ethernet statistics for the primary Ethernet port of the Red Lion device.
eth0.arp.clear
eth0.arp.clear <no arguments>
Clears the ARP cache of the Red Lion device and reports result.
eth0.arp.status
eth0.arp.status <no arguments>
Returns the current ARP table in the Red Lion device.
eth0.dhcp.status
eth0.dhcp.status <no arguments>
Reports DHCP statistics for the primary Ethernet port of the Red Lion device.
eth0.status
eth0.status
Reports Ethernet status information for primary Ethernet port of the Red Lion device.
ident.get
ident.get <no arguments>
Outputs identity information of the target device.
ident.set
ident.set number
Sets the Variant property of the Red Lion device’s identity properties.
ip.config
ip.config <no arguments>
Returns the IP address configuration of the Red Lion device.
ip.routes
ip.routes <no arguments>
Reports all IP routes in Red Lion device.
ip.status
ip.status <no arguments>
Reports the status of all Ethernet sockets.
mem.status
mem.status <no arguments>
Reports the memory status of the Red Lion device.
nic0.status
nic0.status <no arguments>
Reports the NIC statistics of the primary Ethernet port.
nic1.status
nic1.status <no arguments>
Reports the NIC statistics of the auxiliary Ethernet port.
progs.list
progs.list <no arguments>
Reports the list of user program names in the current database.
progs.run
progs.run programname
Runs the user program indicated by the program name and reports when complete.
tags.get
tags.get name
Reports current value of the tag name indicated.
tags.list
tags.list <no arguments>
Outputs the list of Crimson Tags in the current database.
tags.set
tags.set name value
Sets the value of the tag name indicated then reports the current value.
Disclaimer
It is the customer's responsibility to review the advice provided herein and its applicability to the system. Red Lion makes no representation about specific knowledge of the customer's system or the specific performance of the system. Red Lion is not responsible for any damage to equipment or connected systems. The use of this document is at your own risk. Red Lion standard product warranty applies.
Red Lion Technical Support
If you have any questions or trouble contact Red Lion Technical Support by clicking here or calling 1-877-432-9908.
For more information: http://www.redlion.net/support/policies-statements/warranty-statement