Universal Device Driver Reference Manual

This is the Universal Device Driver Reference Manual of the sat-nms MNC software. It mainly describes how to make the device drivers and remote control protocol definitions to interface with different equipment.

Support and Assistance

If you need any assistance regarding the sat-nms software, do not hesitate to contact us. We would be pleased to help you.

  SatService GmbH
  Hardstrasse 9
  78256 Steisslingen
  Germany
  phone +49 7738 99791-10
  www.satnms.com

Version 3.85.0-a -- 2026-07-01 -- © 2003-2026 SatService GmbH

Table Of Contents:

• 1 Device Driver Reference
• 1.1 Understanding the device driver
• 1.1.1 Variables
• 1.1.2 Procedures
• 1.1.3 Protocol encapsulation
• 1.2 Writing a device driver
• 1.2.1 Starting from scratch
• 1.2.1.1 General file format
• 1.2.1.2 Naming a device driver
• 1.2.1.3 Selecting a communication protocol
• 1.2.1.4 File includes
• 1.2.1.5 Tweaking the processing sequence
• 1.2.2 Defining variables
• 1.2.2.1 The VAR statement
• 1.2.2.2 The ALARM statement
• 1.2.2.3 Info variables
• 1.2.2.4 Setup variables
• 1.2.2.5 Variables for internal use
• 1.2.3 Using conversion tables
• 1.2.3.1 The TABLE statement
• 1.2.4 Adding data exchange procedures
• 1.2.4.1 The PROC statement
• 1.2.4.2 ASYNC procedures
• 1.2.5 Basic I/O functions
• 1.2.5.1 The PRINT statement
• 1.2.5.2 The INPUT statement
• 1.2.5.3 The WRITE statement
• 1.2.5.4 The READ statement
• 1.2.5.5 Function tables in I/O functions
• 1.2.6 REST I/O functions
• 1.2.6.1 The REST TRANSACT statement
• 1.2.6.2 The REST PARSE statement
• 1.2.6.3 The REST SET statement
• 1.2.6.4 The REST CLEAR statement
• 1.2.6.5 The REST SEND statement
• 1.2.7 Conditional execution
• 1.2.7.1 The IF statement
• 1.2.7.2 The GOTO statement
• 1.2.7.3 Label definition
• 1.2.8 Using subroutines
• 1.2.8.1 The CALL statement
• 1.2.9 Manipulating variables
• 1.2.9.1 The SET statement
• 1.2.9.2 The BITSET statement
• 1.2.9.3 The RANGESET statement
• 1.2.9.4 The BITSPLIT statement
• 1.2.9.5 The BITMERGE statement
• 1.2.9.6 The SEND statement
• 1.2.9.7 The COPY statement
• 1.2.10 More statements
• 1.2.10.1 The DELAY statement
• 1.2.10.2 The LOG statement
• 1.2.10.3 The DRATE statement
• 1.2.10.4 The SRATE statement
• 1.2.10.5 The WRITEHEX statement
• 1.2.10.6 The READHEX statement
• 1.2.10.7 The INVALIDATE statement
• 1.2.10.8 The SYNC statement
• 1.2.10.9 The RAISECOMMFAULT statement
• 1.3 The RPN language extension
• 1.3.1 The RPN stack
• 1.3.2 The { ...} statement
• 1.3.3 RPN command reference
• 1.4 SNMP device classification and variable binding
• 1.4.1 Device driver syntax for SNMP definitions
• 1.4.2 List of SNMP device classes and OID names
• 1.5 Device driver examples
• 1.5.1 NDSatCom-KuBand-Upconverter Example
• 1.5.2 Tandberg-Alteia Example
• 1.6 Device communication protocols
• 1.6.1 Writing a communication protocol definition
• 1.6.2 General file format
• 1.6.3 Global definitions
• 1.6.4 TX message elements
• 1.6.4.1 CHAR
• 1.6.4.2 ADDRESS
• 1.6.4.3 USERDATA
• 1.6.4.4 CHECKSUM
• 1.6.4.5 DATALENGTH
• 1.6.4.6 HEXLENGTH
• 1.6.4.7 SEQUENCE
• 1.6.5 RX message elements
• 1.6.5.1 START
• 1.6.5.2 CHAR
• 1.6.5.3 ADDRESS
• 1.6.5.4 USERDATA
• 1.6.5.5 STRING
• 1.6.5.6 CHECKSUM
• 1.6.5.7 DATALENGTH
• 1.6.5.8 HEXLENGTH
• 1.7 Device oriented user interface
• 1.7.1 How the software finds the screens for a device
• 1.7.2 Creating new screens
• 1.7.3 Creating a 'frame' definition
• 1.7.4 Icon reference
• 1.8 Online Help
• 1.8.1 Help file format
• 1.9 ServiceClient library
• 1.9.1 Adding new devices or device types to the library
• 1.9.2 Adapting the appearance of the ServiceClient
• 1.10 Reference Tables
• 1.10.1 Device driver keyword reference
• 1.10.2 Protocol definition keyword reference
• 1.10.3 Help file keyword reference
• 1.10.4 Debugging with Terminal Session
• 1.10.4.1 Terminal Session Commands
• 1.10.4.2 Device Message Commands
• 1.10.4.3 CSM debugging
• 1.10.5 Global faults