SageNET Manual ISS 1
SageNET Manual ISS 1
Table of Contents
1. Introduction.............................................................................................................................. 4
1.1 Nomenclature .................................................................................................................... 4
1.2 Getting Started .................................................................................................................. 4
1.2.1 Package Contents......................................................................................................... 4
1.2.2 Minimum Requirements ............................................................................................... 4
2. Installation................................................................................................................................ 5
2.1 Installing SageNET ........................................................................................................... 5
2.1.1 Installing the SageNET Unit ........................................................................................ 5
2.1.2 Installing the SageNET Configuration Tool............................................................... 8
2.1.3 Installing the SageNET MIB ........................................................................................ 8
2.1.4 Installing the Java Runtime Engine ............................................................................ 8
2.2 Running the SageNET Configuration Tool for the first time ....................................... 9
2.3 Network Setup .................................................................................................................10
2.3.1 Network Protocols .......................................................................................................11
2.3.2 Network Setup & Troubleshooting ............................................................................12
3. SageNET Configuration Tool Operation ........................................................................14
3.1 Introduction ......................................................................................................................14
3.2 The Main Screen.............................................................................................................14
3.2.1 The Module Tree .........................................................................................................15
3.2.2 The Module Information Area....................................................................................15
3.3 Pull-down Menus .............................................................................................................16
3.3.1 File Menu......................................................................................................................17
3.3.2 Module Menu ...............................................................................................................17
3.3.3 Tools Menu ..................................................................................................................19
4. Operation ................................................................................................................................19
4.1.1 SageNET Module Parameters Window...................................................................19
4.1.2 User Management Window .......................................................................................29
4.1.3 Reporting Options .......................................................................................................30
5. SNMP .......................................................................................................................................30
5.1 SNMP MIB Structure ......................................................................................................30
5.1.1 psIdent ..........................................................................................................................30
5.1.2 csuStatus ......................................................................................................................30
1. Introduction
The SageNET system is an embedded network server, attached to a Sageon Control Unit
that allows the Sageon Power Plant to be accessed from anywhere in the world.
SageNET runs over any IP network, including the Internet, and allows monitoring of the site
via the Sageon’s proprietary SageView protocol, as well as SNMP and HTTP.
The SNMP interface allows alarm notification via traps, and read only access to all of the
system controller parameters, with a remote Network Management System. The SageNET
unit allows you to setup which alarms you want reported as SNMP traps.
Using the SageVIEW monitoring and control program, you may configure and monitor the
system controller on up to 2 separate computers, at any given time. Alternatively, you can
monitor the system controller’s status via a web browser with no additional software required.
1.1 Nomenclature
Throughout this manual the following styles are used to differentiate between pull-down
menus and selections.
File Menu Denotes a pull down menu from the menu bar at the top of the window
Print Denotes a selection option within a pull down menu
SCU Denotes a short-cut button on the toolbar below the menu bar
2. Installation
2.1 Installing SageNET
There are two methods of setting your SageNET unit up on your network.
• ARP and Telnet
• XPort Installer
Each of these methods has its advantages, and you should choose the method that suits
your particular needs.
From your network administrator obtain a new static IP address. Also ask for your network
class / subnet mask and default gateway. At the end of this manual you will find a sheet for
SageNET setup data to record your settings.
Connect PC to the SageNET’s network interface (directly using a crossover Ethernet cable or
via a network hub). Note: The PC must be on the same physical network subnet as the
SageNET being configured.
Power-up the SageNET.
Notes:
i. The IP address used here is an example and a value within the range of
allowable IP addresses in your network may need to be used. The DOS
command ipconfig with display the IP address of the Windows-based host
machine.
ii. For the ARP command to work on Windows 95, the ARP table on the PC must
have at least one IP address defined other than its own.
2. If you are using Windows 95, type ARP -A at the DOS command prompt to verify
that there is at least one entry in the ARP table. If the local machine is the only entry,
ping another IP address on your network to build a new entry in the ARP table; the IP
address must be a host other than the machine on which you are working. Once there
is at least one additional entry in the ARP table, use the following command to ARP an
IP address to the unit:
3. Open a Telnet connection to port 1. The connection will fail quickly, but the unit will
temporarily change its IP address to the one designated in this step.
telnet 192.168.0.97 1
4. Finally, open a Telnet connection to port 9999, and press Enter within three
seconds to go into Setup Mode. If you wait longer than three seconds, the unit will
reboot.
Note: The IP address you just set is temporary and will revert to the default value
when the unit 's power is reset unless you log into the unit and store the changes
permanently. Refer to the chapter on configuration for instructions on permanently
configuring the IP address.
Lantronix, Inc, 2002, all rights reserved, used herein by permission from Lantronix.
Note:
One Windows 2000 and Windows XP systems equipped with multiple network interfaces, it
is necessary to specify which physical network port the ARP command should use. Using
the command-line program ipconfig, identify the IP address of the port on your computer
that is connected to the SageNet. In the following example, assume ipconfig returns
192.168.0.22 as the IP address for your computer’s port. The ARP command would then
be:
arp -s 192.168.0.97 00-20-4a-xx-xx-xx 192.168.0.22
2.2 Running the SageNET Configuration Tool for the first time
If you are using Windows 2000 or XP, it is advised that you run the program under yourname
with which you will mostly run the program in the future.
At the beginning of the boot up of the Configuration Tool, you will be presented with a request
for a username, as such;
To retrieve this code, you need to email [email protected] with your company name,
yourname typed into the previous screen, and the program ID, found in the title bar of this
window. You may press cancel to exit the program, until you retrieve this code.
This security code need only be entered once to unlock the program. This feature is to
ensure that the configuration tool cannot be installed and run on any unauthorised
computers. Yourname entered in the above screen is not yourname that will be used for log
in to the system.
After the application has been unlocked, the program will request your general username and
password on the following screen. The default username is: Administrator and the default
password is: configuration.
This password screen will appear every time you run the configuration tool. It is to ensure
that no unauthorised user can log in to the system. This prevents unauthorised users from
making critical changes to any SageNET units.
Please change the default password immediately. Accessing your Management option of
the Tools menu (see …) can do this.
NOTE:
Every attempt to log in to the application is logged in the system event log, and also sent to a
syslog server on the network. (see section Reporting Options).
Class A networks are fairly major networks, and generally used by military or governments.
Class B networks are normally used for large companies, with a lot of computers on the
Internet. Class C networks are reserved for small – medium companies.
There are 4 exceptions to the above. The IP address 127.0.0.1 is used exclusively as a
loopback address, also the following 3 ranges are used as internal network addresses only,
and cannot be used on the Internet.
Class Range Start Range End
Class A 10.0.0.0 10.255.255.255
Class B 172.16.0.0 172.31.255.255
2.3.1.2 Ports
Ports are an integral component of the TCP and UDP standards. For each standard, there
are 65535 ports that can be used to access the network device. Some of the ports are
defined, (known as the ‘Well Known Ports’), some are reserved, and some are free to be
used.
An example of ports, is when an Internet browser, (such as Internet Explorer or Netscape),
requests a web page, a TCP connection is established between the 2 computers. However,
if the connection were established between the 2 computers, and not ports of the 2
computers, the computers would then be effectively closed to any other incoming
connections. So, instead, the browser connects to a single port, (in the case of HTTP, this is
port 80). This allows both computers to still accept any incoming connections on any of the
other open ports they have.
One good way to look at these ports is doors to a building. You have an address for the
building, which is your IP address, as described above. The ports then become the entries to
the building. Without making a connection to the port, you cannot enter.
2.3.2.4 Firewalls
Firewalls are devices that block incoming (and sometimes outgoing) packets from accessing
your network. It is a method of stopping any network ‘hacking’. In current day systems,
firewalls are in common use with most Internet connections.
The way a firewall works, is it blocks any attempts to establish a connection with the network
device. The connections are generally blocked when a PC or network device attempts to
connect to the internal network from the Internet.
Many firewalls also provide security by for data which must pass across the Internet, this
feature being referred to as virtual private networking (VPN). Using SageNET across the
Internet without any form of encryption is NOT recommended. All data transfer is in an
unprotected state, and is vulnerable to attack. Remote access across the Internet should be
done via a virtual private network.
To use SageNET across the Internet, you must ensure that certain ports are available for
connection. Most of these ports are configurable, such as the WinCSU-2 connection ports;
the web interface connection port and the configuration and firmware upgrade ports. Some
ports, are not configurable, such as the SNMP trap (UDP Port 162) and SNMP monitoring
ports (UDP Port 161), and the HTTP connection ports (TCP Port 80).
To utilise the features of SageNET, you will need to ensure that all ports you decide to use
are open to the Internet
For a full list of the TCP and UDP port assignments, please refer to:
http://www.iana.org/assignments/port-numbers
Each firewall has its own way of configuring ports for usage. Please refer to the firewall
manuals for instructions on how to open ports.
3.2.2.2 IP Address
The IP Address of the module that you wish to connect to, is set here.
TIP: If you wish to upload the same module configuration to more than one unit, create a
template and upload to each unit by adjusting the IP Address each time.
3.2.2.3 Port No
The configuration port of the SageNET module will not normally require changing from the
default value of 10099. This is the port that you wish to connect to during the next
configuration upload or download.
3.3.1.1 Save
Saves any changes to a module configurations to the local disk for future reference. You will
be asked to save on exit, but to safe guard change in the meantime, they should use the
save menu option.
3.3.1.2 Print
Prints the currently selected window. The Print Dialogue appears, allowing you to select the
appropriate printer and properties.
3.3.1.3 Exit
Exits the SageNET programs and returns to the operating system
3.3.2.1 Properties
Opens the module parameters window that displays and allows editing of the currently
selected SageNET module parameters.
4. Operation
Several parameter windows have been mentioned in the previous sections where system-
operating parameters are displayed and able to be edited. Each time a parameter is
modified, it is highlighted in yellow and will be reset to white when the Write to function is
used within the parameters window. The parameter windows and the function of their listed
parameters are described in this section.
4.1.1.1.1 Manufacturer
This is the manufacturer of the SageNET Unit. It corresponds to the manufacturer variable in
the SNMP MIB, allowing you to configure each SageNET unit’s manufacturer name.
4.1.1.1.2 Model
The model corresponds to the model type of the SageNET unit. Typically, this will be
SageNET, however this may change for your unit, if you wish to rename the model.
4.1.1.1.3 Name
The name of the system in your power network may be stored here, for usage in the
SageNET SNMP MIB.
This is the area where you may describe any attached devices for reporting via SNMP. For
instance, you may wish to show that it is a system is equipped with a Site Monitor or Battery
Monitor, or note how many rectifiers are installed..
4.1.1.1.9 Latitude/Longitude
The Latitude and Longitude sections allow you to keep track of the co-ordinates of the
system, for mapping to a larger system. These values are presented in GPS format, and to
convert to degrees, need you need to follow the following instructions:
For Latitude:
Latitude in Degrees = (gpsLatitude * 90) / ((2^31)-1)
For Longitude:
Longitude in Degrees = (gpsLongitude * 180) / ((2^31)-1)
4.1.1.1.10 Location
Location allows you to describe where to module or power supply is situated. This could be
an address, or an office, etc.
The trap reception section is where you can configure what IP addresses the traps for the
system should be sent to.
4.1.1.4.9.1 Enabled
The first option is whether the SNTP protocol will be used. If it is not enabled, the SCU will
use the time that it currently has, until it is updated by SageView. If it is enabled, the SNTP
client running on the SageNET module will update the SCU time on boot up and every 24
hours thereafter.
You can shut down the SNMP traps and monitoring ports using this option.
The user management window is used to maintain the users allowed to access the
configuration tool. After the initial installation of the program, it is highly recommended that
you change the administrator password from the default.
Any changes made to the users database is automatically logged in the system event logs,
and if configured, is logged using the syslog protocol, to the set up syslog server.
You may insert the IP address of a computer that runs a syslog daemon here. This allows
you to monitor changes made to SageNET configurations, and your management of the
configuration software from a remote computer.
5. SNMP
5.1 SNMP MIB Structure
The SNMP MIB has a tree structure to group and describe the variables available to you.
5.1.1 psIdent
The psIdent section contains all the system identification fields. These are all the fields that
pertain to the asset management of the SageNET module.
5.1.2 csuStatus
The csuStatus section contains the current status of the controller, and overall system.
These fields are information about the system voltage, the total load current, and information
about the incoming mains power.
It also contains a table, describing the status of the batteries. This table will always contain
four rows, but the validity of the rows is dependant on the csNumBats variable, as this tells us
how many batteries there are.
The table contains the following information:
• Battery number
• Battery current
• The estimated battery charge remaining
• The estimated battery time remaining (NOTE: This only provides a crude indication of
battery time remaining and its reliability is heavily reliant on the data your provides.
The Battery Rating and the Estimation Battery Time Remaining Factor are key pieces
of information that your provides).
NOTE: The table always contains 4 rows; the relevancy of the data is dependant upon the
number of batteries in the system.
5.1.3 csuTest
The csuTest section holds the information about the last battery discharge test. It holds
information about the time and date, length, and result of the battery discharge test.
This section also contains a table that holds the estimated battery charge remaining after the
completion of the battery discharge test.
5.1.4 csuSysConfig
The csuSysConfig holds the information about the configuration of the controller, which
includes the options the controller has been configured with. This is presented as a table,
which lists all configuration settings as SNMP objects in the range from
scSysConfigSiteMonitor to scSysConfigTemperatureUnitFahrenheit.
5.1.5 csuParam
csuParam holds all the information about the controller parameters. All values are read only,
and include such parameters as, number of rectifiers, number of batteries, AC voltage high
and low alarms settings.
5.1.6 csuAlarmLog
The csuAlarmLog section holds the information of all currently active controller alarms. It
does so using a table, with links to identity nodes. The first readable variable is alLogSize,
which contains the number of active alarms, and also csuAlarmLogTable, which contains four
sub-sections to be filled:
• The log index;
• The alarm code;
• The descriptions as SNMP objects in the range from alAlarmEEPROMFail to
alAlarmLogAlarm7Bit7; and
• The time the alarm was set.
NOTE: The alarm time is the point in time the alarm was triggered, relative to the uptime of
the module. This is not the SNTP synchronised time, but the value in seconds that the
module has been powered up for.
5.1.7 smrStatus
smrStatus contains information about the status of all the rectifiers in the power system. It
contains the information for each rectifier, and the overall alarm log for the rectifiers. Both of
these are presented in tables. Each line of the table for the status information includes:
• Rectifier index;
• Rectifier number for the entry;
• Rectifier current being used;
• Rectifier float voltage;
5.1.8 smrParam
smrParam contains information about the parameters of the rectifiers connected to the
system.
5.1.9 cellVoltages
The cellVoltages section all the battery information is reported via variables and a table. The
overall system information, such as Cell Voltage High alarm, and configuration information
are all leaves of the cellVoltages branch.
Actual cell voltage information for each cell in the system is reported as a table including:
• The block index;
• The battery number;
• The block number;
• The cell voltage.
5.1.10 siteMonitorStatus
siteMonitorStatus covers all the site monitor status information for the power system. It
reports back:
• Site Monitor analog channels current status table size;
• A table that contains:
o Site Monitor analog channel number;
o Site Monitor analog channel current value;
• Site Monitor digital channels current values table size;
• A table that contains:
o Site Monitor digital channel number;
o Site Monitor digital channel current value;
• The status of Site Monitor Output Relay control 1 to 4;
• The Site Monitor Alarm Log Size;
5.1.11 siteMonitorParam
The siteMonitorParam branch contains the set-up and configuration information for the site
monitor peripherals. It includes the following information:
• Site Monitor Enabled;
• Site Monitor Analog Parameters Size;
• A table to describe the site monitor analog parameters, containing:
o Site Monitor analog channel number;
o Site Monitor analog channel alarm enable;
o Site Monitor analog channel full scale rating;
o Site Monitor analog channel upper alarm threshold;
o Site Monitor analog channel lower alarm threshold;
o Site Monitor user description label for this analog channel;
o Site Monitor unit label for this analog channel;
o Site Monitor output relay control 1 to 4 for this analog channel;
• Site Monitor digital channel parameter values table size;
• A table of the Site Monitor digital channel parameters, containing:
o Site Monitor digital channel number;
o Site Monitor digital channel alarm enable;
o Site Monitor user description label for this digital channel;
o Site Monitor normal state for this digital channel;
o Site Monitor output relay control 1 to 4 set-up for this digital channel.
5.1.12 csuTraps
SageNET implements 6 traps, which notify a NMS of alarms in the power system. An
explanation of each of these traps is detailed below.
5.1.12.1 csuTrapOnBattery
This trap is a notification that the system is operating on battery power. This trap is persistent
and is resent at one minute intervals until either the batteries are discharged or the system is
no longer running on battery. It reports the number of batteries present in the system (up to 4)
and the charge remaining for all 4 possible batteries. The charge remaining for non-existent
batteries should be ignored.
5.1.12.2 csuTrapOnBDTCompleted
This trap is a notification that a Battery Discharge Test has been completed. It reports the test
results as an integer (see ctLastDischargeTestResult variable):
1: ldtFailed(1)
2: ldtPassed(2)
3: ldtNotAvailable(3)
4: ldtLowLoad(4)
5: ldtRectifierOverload(5)
6: ldtNoControl(6)
7: ldtUserTerminated(7)
8: ldtACLost(8)
9: ldtCellVoltageLow(9)
10: ldtBatteryCTFailed(10)
11: ldtUnknown(11)
5.1.12.3 csuTrapAlarmLogEntryAdded
This trap is a notification that an alarm has been inserted into the alarm table (see
csuAlarmLog variable). It reports the alarm code and description as an SNMP object in the
range from alAlarmEEPROMFail to alAlarmLogAlarm7Bit7. Only the alarms selected by your
using the configuration tool are reported.
5.1.12.4 csuTrapAlarmLogEntryRemoved
This trap is a notification that an alarm has been removed from the alarm table (see
csuAlarmLog variable). It reports the alarm code and description as an SNMP object in the
range from alAlarmEEPROMFail to alAlarmLogAlarm7Bit7.
5.1.12.5 csuTrapCSUParameterChange
This trap is a notification that a SCU parameter has been changed from the front panel. It
reports 2 variables that are current not used cpCSUParameterUserName and
cpCSUParameterChangedDesc.
5.1.12.6 csuTrapCSUOffline
This trap is a notification that the SNMP interface has lost contact with the SCU (power
system monitoring unit). This trap is persistent and is resent at one-minute intervals until
communications has been restored.
5.1.13 release
The release branch contains all the current release information of the SNMP MIB tree. It
contains contact information and version information of the MIB.
6. SNTP
The SNTP server allows the SageNET module to automatically calibrate the controller’s time
according to an extremely accurate Internet time source, (see http://www.ntp.org/ for listings
of some time servers, and more information about the NTP protocol). When the time server
is enabled, and the host name or IP address in the configuration tool (see ….), is set up to
point to an internet time server, the SageNET module will get an update of the UTC time on
boot-up and every 24 hours thereafter, which is used to update the SCU internal clock.
7. SageView Connectivity
SageNET allows you to connect 2 copies of SageView to each SCU. The ports that
SageView connect to are configurable via the configuration tool’s connection options.
Although SageNET can support simultaneous connections on two different TCP/IP ports, the
current SageView program only supports communications on port 10001.
* Note *
The Sageon Power Systems supports concurrent access via the front panel serial port
and the network port (i.e. SageNET). Since SageNET can support two simultaneous
connections, it is theoretically possible for three users to be accessing the Sageon
plant at the same time. The possibility exists that all three users may try changing the
Sageon’s configuration at the same time, to prevent possible corruption of
configuration information that may be caused by such a simultaneous change, the
Sageon Plant Controller employs a write-lockout feature.
When the first attempt is made to change the Sageon’s configuration via Sagenet, the
Sagenet connection making the change is awarded Write-Access privileges. Once
this occurs, this connection is the only one that can make configuration changes, the
other connections will receive a busy message if they attempt to change
configuration. When the connection with Write-Access privileges is done making
changes, it must log off (i.e. disconnect SageView from the power plant). When the
connection is disconnected, the Write-Access privilege is cancelled after 20 seconds.
At this time, any other connection (including a new SageView connection on the same
port) can gain Write-Access.
8. Web Interface
The web interface may be accessed via the web address: http://<ip-address-of-module>/
It requires the Java Runtime engine 1.4.1_03 (or higher) be installed on the browsers system,
and also requires the Web Interface port be open on any firewall between the 2 systems.
Please see your network administrator for help with these requirements.
The web page has 2 main sections. The first (in grey), includes all the status information,
read from the SageNET module. It shows the system voltage, the load current and the
number of alarms. This is updated every 5 seconds.
The second section shows all of the version information from the SageNET unit, and the Java
version information.
Important Note: Certain Internet Security programs which implement software firewalls (such
as McAfee Security Center and Norton Personal Firewall may prevent the Java applet from
loading the Webpage and Firmware Versions. If you see <Not Detected> for these values,
please check your computer for such software and disable it wile accessing SageNET.
9. Telnet
SageNET provides telnet capability, to control the basic parameters of the system. You can
access the telnet system by typing:
telnet <ip-address-of-unit> 9999
You will then be asked to ‘Press Enter to go into Setup Mode’
If you press Enter, you will be presented with a menu. This menu will contain 3 options.
• Server Configuration
• Exit without save
• Save and Exit
9.1.1 IP Address
The IP address must be set to a unique value in your network. See Appendix A for more
information about IP Addressing.
Note: SageNET module cannot connect to the network if the assigned IP address is already
in use by another device.
Note: The gateway address must be within the local network segment.
The SageNET module prompts for the number of host bits to be entered then calculates the
netmask, which is displayed in standard decimal-dot notation when the saved parameters are
displayed (for example, 255.255.255.0).
PORT PROTOCOL
TCP Port 80 HTTP
TCP Port 9999 Telnet, non-standard port
TCP Port 1 Telnet, non-standard port
TCP Port 10001* SageView software
TCP Port 10002* SageView software (secondary connection)
Note: Ports marked with an asterisk may be re-configurable using the SageNET
Configuration Program should a port conflict be encountered.
In order for a computer to access the SageNET remotely, any networking equipment (routers,
firewalls, proxy servers, etc..) between the two must configured to pass data on the
appropriate TCP/IP port. If the SageNET can be accessed via web browser (HTTP is the
most universal TCP/IP protocol) but fails for one of the other protocols, then you should
suspect a firewall or proxy server blocking TCP/IP ports to be the cause.
other network segment. In many installations only the commonly used TCP/IP ports
such as HTTP, FTP, POP3, etc.. are allowed to pass through the network segmenting
equipment. It may be necessary to configure the network segmenting equipment to
pass the unique TCP/IP ports required by SagNET. A more detailed discussion of
TCP/IP ports may be found in section 2.3 of the SageNET Manual.
Note:
Due to the compact size of the XPORT connector on the SageNET board, it is necessary
to use an Ethernet cable constructed with premium quality RJ45 connectors. Poor
connections have been observed when using cables constructed from discount or generic
RJ45 connectors. Brand name connectors such as those from AMP will assure proper
operation of your SageNET.
If you are experiencing problems with your SageNET board when it is properly installed,
please check the link status LEDs on the RJ45 connector. If no LEDs are illuminated, a
poor cable connection should be investigated.
Name of Installation:
__________________________