CSI Web Server
Revision: 7/13
Copyright © 2011-2013
Campbell Scientific, Inc.
License for Use
This software is protected by United States copyright law and international
copyright treaty provisions. The installation and use of this software constitutes
an agreement to abide by the provisions of this license agreement.
Campbell Scientific grants you a non-exclusive license to use this software in
accordance with the following:
(1) The purchase of this software allows you to install and use the software on
one computer only.
(2) This software cannot be loaded on a network server for the purposes of
distribution or for access to the software by multiple operators. If the
software can be used from any computer other than the computer on which
it is installed, you must license a copy of the software for each additional
computer from which the software may be accessed.
(3) If this copy of the software is an upgrade from a previous version, you
must possess a valid license for the earlier version of software. You may
continue to use the earlier copy of software only if the upgrade copy and
earlier version are installed and used on the same computer. The earlier
version of software may not be installed and used on a separate computer
or transferred to another party.
(4) This software package is licensed as a single product. Its component parts
may not be separated for use on more than one computer.
(5) You may make one (1) backup copy of this software onto media similar to
the original distribution, to protect your investment in the software in case
of damage or loss. This backup copy can be used only to replace an
unusable copy of the original installation media.
This software may not be sold, included or redistributed in any other software,
or altered in any way without prior written permission from Campbell
Scientific. All copyright notices and labeling must be left intact.
Limited Warranty
The following warranties are in effect for ninety (90) days from the date of
shipment of the original purchase. These warranties are not extended by the
installation of upgrades or patches offered free of charge.
Campbell Scientific warrants that the installation media on which the software
is recorded and the documentation provided with it are free from physical
defects in materials and workmanship under normal use. The warranty does not
cover any installation media that has been damaged, lost, or abused. You are
urged to make a backup copy (as set forth above) to protect your investment.
Damaged or lost media is the sole responsibility of the licensee and will not be
replaced by Campbell Scientific.
Campbell Scientific warrants that the software itself will perform substantially
in accordance with the specifications set forth in the instruction manual when
properly installed and used in a manner consistent with the published
recommendations, including recommended system requirements. Campbell
Scientific does not warrant that the software will meet licensee’s requirements
for use, or that the software or documentation are error free, or that the
operation of the software will be uninterrupted.
Campbell Scientific will either replace or correct any software that does not
perform substantially according to the specifications set forth in the instruction
manual with a corrected copy of the software or corrective code. In the case of
significant error in the installation media or documentation, Campbell
Scientific will correct errors without charge by providing new media, addenda,
or substitute pages. If Campbell Scientific is unable to replace defective media
or documentation, or if it is unable to provide corrected software or corrected
documentation within a reasonable time, it will either replace the software with
a functionally similar program or refund the purchase price paid for the
software.
All warranties of merchantability and fitness for a particular purpose are
disclaimed and excluded. Campbell Scientific shall not in any case be liable for
special, incidental, consequential, indirect, or other similar damages even if
Campbell Scientific has been advised of the possibility of such damages.
Campbell Scientific is not responsible for any costs incurred as a result of lost
profits or revenue, loss of use of the software, loss of data, cost of re-creating
lost data, the cost of any substitute program, telecommunication access costs,
claims by any party other than licensee, or for other similar costs.
This warranty does not cover any software that has been altered or changed in
any way by anyone other than Campbell Scientific. Campbell Scientific is not
responsible for problems caused by computer hardware, computer operating
systems, or the use of Campbell Scientific’s software with non-Campbell
Scientific software.
Licensee’s sole and exclusive remedy is set forth in this limited warranty.
Campbell Scientific’s aggregate liability arising from or relating to this
agreement or the software or documentation (regardless of the form of action;
e.g., contract, tort, computer malpractice, fraud and/or otherwise) is limited to
the purchase price paid by the licensee.
Table of Contents
PDF viewers: These page numbers refer to the printed version of this document. Use the
PDF reader bookmarks tab for links to specific sections.
1. CSI Web Server Administrator...................................2
1.1 Status....................................................................................................2
1.2 Configuration .......................................................................................3
1.2.1 Edit Root Permissions...................................................................3
1.2.2 HTTP ............................................................................................3
1.2.3 HTTPS ..........................................................................................3
1.2.4 Log Control...................................................................................4
2. Web Publisher.............................................................5
2.1 Creating Websites ................................................................................6
2.2 Managing Websites..............................................................................9
3. Web Security ...............................................................9
3.1 PC Websites .........................................................................................9
3.1.1 Using the CSI Web Server Administrator...................................10
3.1.2 Using the Web Publisher.............................................................12
3.2 Datalogger Websites ..........................................................................12
4. API Commands .........................................................13
4.1 Command Syntax ...............................................................................13
4.2 Data Access Commands.....................................................................13
4.3 Control Commands ............................................................................18
4.4 File Management Commands.............................................................21
i
Table of Contents
ii
CSI Web Server
The CSI Web Server allows you to view your RTMC projects using a web
browser. Included with the CSI Web Server are the CSI Web Server
Administrator and the Web Publisher. The CSI Web Server Administrator
allows you to configure the web server, check the status of the web server, set
up user accounts and passwords, and easily browse to sites running on the web
server. The Web Publisher allows you to publish your RTMC project to either
a PC website using the CSI Web Server or to an HTTP-enabled datalogger.
The diagram below shows the basic steps in creating your web content.
Lay Out and Design
Web Pages in
RTMC
Publish Web Files
Using
Web Publisher
Datalogger
Web Server
CSI
Web Server
Web Browser Displays
Interactive Web Pages
You first use RTMC to create a project containing the display and/or control
components that you want to be available from your website. Next, the Web
Publisher is used to publish the web files. From RTMC Pro, you can press the
Publish to Web button (
project. (The Web Publisher can also be opened from the Windows Start Menu
by selecting Programs | Campbell Scientific | CSI Web Server | Web
Publisher.) From the Web Publisher, you can choose to add a PC Website or a
Datalogger Website. After filling in the desired settings, press the Publish
Website button to publish the content.
) to bring up the Web Publisher and publish your
1
CSI Web Server
The CSI Web Server supports the following target browsers at the indicated
version or later:
Chrome 10
Firefox 4
Internet Explorer 9
Opera 11
Safari 5
NOTE
If firewalls exist between your web server (i.e., a PC running CSI
Web Server or a web-enabled datalogger) and the target audience
of your website(s), the firewalls will need to be configured to
allow incoming traffic on the port being used by the web server.
(The port used by the CSI Web Server is configured through the
CSI Web Server Administrator. The port used by a web-enabled
datalogger is configured through DevConfig. The default port is
80 for both the CSI Web Server and a web-enabled datalogger.)
See your network administrator for help in configuring the
firewalls.
1. CSI Web Server Administrator
The CSI Web Server Administrator allows you to configure the web server,
check the status of the web server, set up user accounts and passwords, and
easily browse to sites running on the web server. It can be opened from the
Windows Start Menu by selecting Programs | Campbell Scientific | CSI Web
Server | CsiWebAdmin.)
1.1 Status
The Status tab shows the status of the web server and allows you to browse to
sites running on the web server.
2
If the web server is not running, click on the image to start the web server.
When the web server is running, the version of the web server running will be
displayed. The protocol, port, and status (e.g., Protocol HTTP, port 80, status
Listening) will also be displayed.
A list of sites provided by the web server will be shown. You can click on any
site to browse to that site.
The keys icon (
.csipasswd file for that site. See Section 3, Web Security, for more information
about .csipasswd files and how they control users and their website access
rights.
The plus icon (
use the keys icon next to the new remote folder to create the .csipasswd file for
that remote folder before publishing a website to the folder. See Section 2,
Web Publisher, for information on publishing a website to the remote folder.
) next to each site can be used to create or edit the
) next to “Root” creates a new remote folder. You can then
CSI Web Server
The trash can icon ( ) next to each website can be used to remove the
website.
NOTE
Only sites published to the web server’s root directory and
immediate subdirectories of the root directory will be shown.
Sites cannot be published to deeper subdirectories.
1.2 Configuration
1.2.1 Edit Root Permissions
The Edit Root Permissions button is used to create or edit the root .csipasswd
file. It performs the same function as the keys icon next to Root on the Status
tab, but can be used to edit the root permissions even when the CSI Web Server
is not running. See Section 3, Web Security, for more information on the
function of the root .csipasswd file.
1.2.2 HTTP
The HTTP tab controls the root directory and HTTP server port that will be
used by the CSI Web Server.
HTML Root Directory – The directory that the web server will use to
store/serve web pages, scripts, password files, and source description files.
HTTP Server Port – The TCP Port on which the HTTP server will listen for
unencrypted connections. You may need to change this port if there is already a
web server running on this machine or if your firewall does not allow service
on TCP port 80.
1.2.3 HTTPS
The HTTPS tab can be used to set up the CSI Web Server for encrypted
service. This requires a Private Key File and Certificate File obtained from a
third party Certificate Authority.
HTTPS Enabled – Specifies whether the web server will attempt to offer an
HTTPS (encrypted) service.
Server Name – Specifies the domain name that the server will report when it
redirects requests from an unsecure link to a secure one. This will only happen
if the HTTPS protocol is enabled and the private key and certificate have valid
content. This value should be the Fully Qualified Domain Name (FQDN) for
your web server and, depending upon firewalls, proxies, and port-forwarding
configurations, may be different from the host machine name.
HTTP Server Port – Specifies the TCP port on which the HTTP server will
listen for unencrypted connections. You may need to change this port if there
is already a web server running on this machine or if your network or personal
firewall do not allow service on TCP port 80.
3
CSI Web Server
1.2.4 Log Control
Private Key File – Specifies the name of the PEM encoded file that contains
the HTTPS private key. The TLS/SSL stack used by the web server supports
only AES128 or AES256 encryption for the private key file.
Private Key Password – Specifies the password used to decrypt the TLS/SSL
private key. It will be ignored if a private key is specified that is not encrypted.
Certificate File – Specifies the name of the PEM-encoded file that contains the
x509 HTTPS certificate.
The Log Control tab allows you to configure how log files are maintained by
the CSI Web Server.
Log File Mode – Controls the way that the web server will write its log files.
Select Disabled to disable log files, New Log on Time Intervals to specify
that a new log file will be started on the time interval specified by the Baling
Interval, or New Log after Max Size to specify that a new log file will be
started after the current log file exceeds the size specified by the Maximum
Log File Size.
Log Files Directory – Specifies the directory in which the web server will
write its log files.
Baling Interval – Specifies the maximum time interval that will be recorded in
any one log file when the Log File Mode is set to New Log on Time Intervals.
Maximum Log File Size – Specifies the maximum size (in bytes) that will be
recorded in any one log file when the Log File Mode is set to New Log after
Max Size.
Maximum Log Files Count – Specifies the maximum number of log files that
will be kept by the web server before the oldest is overwritten.
Log HTTP Headers – Controls whether the web server will write the headers
of HTTP requests and HTTP responses in its log file.
4
2. Web Publisher
The Web Publisher allows you to publish your RTMC project to the web. In
addition, the Web Publisher has display settings that allow you to show other
tabs such as data browsing and network status.
CSI Web Server
The Web Publisher supports two kinds of websites: PC websites and
Datalogger websites.
PC Website - PC websites run on the CSI Web Server. The CSI Web Server
supports any number of websites and lets you control user access rights for
each website. PC websites support all of the different data sources supported
by RTMC (LoggerNet, Data File, Database, HTTP Datalogger, and Virtual
Data Sources).
Datalogger Website - Datalogger websites are websites being run on a
compatible datalogger like the CR800, CR1000, and CR3000. Datalogger
websites must be designed by RTMC Pro and can only have one data source.
The data source must be an HTTP Datalogger Source.
5
Loading...