Universal Device Driver Reference Manual

1.10.4.1 Terminal Session Commands

Enter ? on the command prompt to get the following short help overview:

---> ?
general information:
  server / faults / msg-count
messages:
  get <msg-id> / set <msg-id> <v> / loop <msg-id> <v>
message distributors:
  cdis (debug|nodebug)
  ddis (debug|nodebug)
device threads:
  threads / thread <n>
client peers:
  peers / peer <n> (view|verbose|silent|kill)
system:
  restart / shutdown / q
debug log:
  limit / nolimit

server

Shows information of sat-nms MNC server process including:

state: current server state. R = normal operation
clients: number of connected clients
d-threads: number of devices threads (see threads)
msg-rate: The server command outputs the current rate of updated driver variables. The rate is determined over an interval of 5 seconds. Variable update calls are counted and divided by the time that has passed since the rate was last determined. The value is a bit too high in terms of communication to real equipment, because also the (internal) messages between logical devices are counted as well

Example:

---> server
state:       R
clients:     3
d-threads:   54
msg-rate:    505.69 msgs/sec

faults

Shows a list of all devices (one per line) and the current summary faults or warning state. Devices which are ok, just show no message text.

Example: where HPA-2 is in WARNING state and HPA-3 in FAULT state

...
HPA-1:
HPA-2: WARNING
HPA-3: Summary FAULT
S1:
S2

msg-count

Outputs the absolute counter readings of the messages distributed by the MNC server since startup. Starts with a high number, because all the range messages are counted at the start.

Example:

distributed messages
  from devices 2167806180
  to devices   2261258

cdis debug / cdis nodebug

Enables or disabled debug output on stdout (usually found in /home/satnms/.panic.log ) for the client distributor. This show messages going from server to the clients (including other devices).

Attention : Enabling this output creates huge amount of date which on the disk. Do not forget to disable after testing.

Example: A beacon level (parameterId BCRX.power) is send to client and to a File-Recorder logical device.

BCRX.power distributed to satnms3.vlc.ClientPeer (176)
BCRX.power distributed to satnms3.device.FileRecorder@57576068

ddis debug / ddis nodebug

Enables or disabled debug output on stdout (usually found in /home/satnms/.panic.log ) for the device distributor. This show messages going to devices (including logical devices).

Attention : Enabling this output creates huge amount of date which on the disk. Do not forget to disable after testing.

Example: A BUC is commanded to transmit (parameterId BUC-1.tx.on). This messages usually have their origin from user input.

Example:

BUC-1.tx.on distributed to tx.on ON

threads

Shows all list of all threads (which corresponds to the interface definition) and the current thread state. A threads / interface can have 1 or more attached devices.

Example:

---> threads
0   I  DT-null      (2 devices)
1   R  DT-null      (1 devices)
2   I  DT-null      (6 devices)
3   I  DT-10.10.1.13:4001(1 devices)
4   I  DT-ttyS11    (1 devices)
5   I  DT-ttyS0     (1 devices)

thread n

Show details for thread n. This includes (for each device attached to this thread/interface)

device name
device class: a Java class name if the device is hardcoded or contains hardcoded function, or satnms3.device.UniversalDriver if the driver is written completely in the sat-nms Universal Device Driver Language
driver name
measured cycle time: minimal/average/maximal measured cycle time in msec. This show how long the device needs to go through all GET (and PUT) procedures. It includes the idle time as configured for this interace (usually 1000 msec)
protocol name
protocol class: a Java class name if the protocol is hardcoded or satnms3.proto.TTYProtocol if the protocol is written in the sat-nms Universal Device Driver Language
interface
response time: minimal/average/maximal measured response time for messages send to a (real) device in msec.
thread state

Example: sat-nms LBRX Beacon Receiver with HTTP protocol

---> thread 19
thread 19 DT-null (I)
  device 1
    device name: BCRX-1M8
    device class: satnms3.device.UniversalDriver
    driver name: SatService-Beacon-Receiver 3.03 200430
    measured cycle time: 1124/1254/1378 msec
    protocol name: HTTP 1.01 090728
    protocol class: satnms3.proto.HTTProtocol
    interface: null
    response times: 120/157/215 msec

peers

Show list of all connected clients and their current state

Example: 3 connected clients from different hosts

---> peers
0   RI  10.10.1.143
1   RI  192.168.2.22
2   RI  192.168.2.34

peer n (view|verbose|silent|kill)

peer function	description
verbose	print all message between client and server
silent	disable verbose output
kill	close connection, drop client
view	show peer details

Example: shows details for client 1

---> peer 0 view
ClientPeer 0:
id:              50
destination:     10.10.1.143
input state:     R
output state:    I
queue fill:      0
uptime:          16d21h
msgs received:   297387
msgs sent:       2637717

Client peer input and output states:

state	description
I	Initializing
R	Reading / waiting for Data
P	Processing Data
D	Dead (Streams closed)
O	Outputting (sending Data)
S	Stopping

Example: enabled client/server verbose output where a new beacon level is send to the client and a keep alive message is exchanged between client and server (ping)

sent BCRX.power -71.56
sent @ping. Fri Jul 30 15:09:47 UTC 2021
got  @cpng.

restart

restart MNC server, similar to satnms-stop; satnms-start on command line or the restart button the client UI.

shutdown

shutdown MNC server. similar to to satnms-stop on command line

close terminal session

limit / nolimit

disabled log rotation of /home/satnms/debug.log.

Attention : Enabling this output creates huge amount of date which on the disk which will cleaned up automatically. Do not forget to disable after testing.