Add documentation for CS-Studio integration.

archiver-appliance · Nov 3, 2015 · fc262e1 · fc262e1
1 parent e74fdb7
commit fc262e1
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 3 deletions.
diff --git a/docs/archiveviewer.html b/docs/archiveviewer.html
@@ -42,7 +42,7 @@
 
 <section>
 <h3>Retrieving data using the ArchiveViewer</h3>
-<p>The EPICS Archiver Appliance comes with a client plugin for the ArchiveViewer that enables the user to retrieve and display data in the ArchiveViewer using the <a href="pb_pbraw.html"><code>PB/HTTP</code></a> protocol.
+<p>The EPICS Archiver Appliance comes with a client plugin for the ArchiveViewer that enables the user to retrieve and display data in the ArchiveViewer using the <a href="pb_pbraw.html">PB/HTTP</a> protocol.
 To download a version of the Archive Viewer with the client plugin for the EPICS Archiver Appliance, please see the <a href="https://github.com/slacmshankar/epicsarchiverap/releases/">Download</a>'s section.
 </p>
 

diff --git a/docs/csstudio.html b/docs/csstudio.html
@@ -0,0 +1,80 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link href="js/bootstrap-3.3.5/css/bootstrap.min.css" rel="stylesheet">
+<link type="text/css" href="docs.css" rel="Stylesheet" />	
+<title>EPICS Archiver Appliance - CS Studio Integration</title>
+</head>
+<body>
+<!-- Header starts here -->
+ <nav class="navbar navbar-inverse">
+  <div class="container-fluid">
+    <div class="navbar-header">
+      <a class="navbar-brand" href="index.html">The EPICS Archiver Appliance</a>
+    </div>
+    <div>
+      <ul id="mainNavBar" class="nav navbar-nav">
+		<li><a href="https://github.com/slacmshankar/epicsarchiverap/wiki">News</a></li>
+		<li><a href="details.html">Details</a></li>
+		<li><a href="https://github.com/slacmshankar/epicsarchiverap/releases/">Download</a></li>
+		<li><a href="quickstart.html">Quickstart</a></li>
+		<li><a href="installguide.html">Installation</a></li>
+		<li><a href="userguide.html">User Guide</a></li>
+		<li><a href="customization.html">Customize</a></li>
+		<li><a href="developersguide.html">Developers</a></li>
+		<li><a href="admin.html">Admin</a></li>
+		<li><a href="api/index.html">Javadoc</a></li>
+		<li><a href="https://github.com/slacmshankar/epicsarchiverap/issues">Issues</a></li>
+		<li><a href="faq.html">FAQ</a></li>
+		<li><a href="license.html">License</a></li>
+	  </ul>
+	  <ul class="nav navbar-nav navbar-right">
+   	    <li><img style="margin-top: -45px" src="images/Icon_Mathematical_Plot.png"/></li>
+	  </ul>
+    </div>
+  </div>
+</nav>
+<!-- Header ends here -->
+
+<div class="container">
+
+<section>
+<h3>Retrieving data using the CS-Studio</h3>
+
+<p><a href="http://controlsystemstudio.org/">CS-Studio</a> 4.X onwards comes with support for the EPICS Archiver Appliance as a data source for the databrowser.</p>
+
+<h5>Configuring CS-Studio</h5>
+CS-Studio communicates with the appliance using the <a href="pb_pbraw.html">PB/HTTP</a> protocol.
+The databrowser can be configured to use the appliance by including the client retrieval URL to the list of Archive data servers.
+From the top menu select <samp>Edit <span class="glyphicon glyphicon-menu-right" aria-hidden="true"></span> Preferences <span class="glyphicon glyphicon-menu-right" aria-hidden="true"></span> CSS Applications <span class="glyphicon glyphicon-menu-right" aria-hidden="true"></span> Trends</samp>
+<ul>
+<li>Add the archiver appliance URL to the set of Archive Data Server URL's
+<ul>
+<li>This URL is generated by replacing the string <i>http</i> with the string <i>pbraw</i> in the <code>data_retrieval_url</code> element of your <code>appliances.xml</code> and looks like so <code>pbraw://archiver.slac.stanford.edu/retrieval</code>.</li>
+</ul>
+</li>
+</ul>
+Example:
+<figure>
+<img src="images/csstudio_config.png" alt="Connecting using pbraw"/>
+</figure>
+
+Once the URL has been added to the preferences, the archiver appliance can be used in the databrowser like any other data source.
+Users can search the archive for PV’s, retrieve data and plot it, etc.
+
+<figure>
+<img src="images/csstudio_plot.jpg" alt="Plotting"/>
+</figure>
+
+</section>
+
+</div>
+
+<script src="js/jquery/1.11.3/jquery.min.js"></script>
+<script src="js/bootstrap-3.3.5/js/bootstrap.min.js"></script>
+<script src="js/arch/docs.js"></script>
+
+</body>
+</html>
diff --git a/docs/details.html b/docs/details.html
@@ -73,7 +73,7 @@
 </ul>
 </li>
 <li>Support for EPICS aliases.</li>
-<li>Support for retrieval of data using <a href="archiveviewer.html">ArchiveViewer</a>, the CSS databrowser and Matlab.</li>
+<li>Support for retrieval of data using <a href="csstudio.html">CS-Studio</a>, the <a href="archiveviewer.html">ArchiveViewer</a> and Matlab.</li>
 <li>Limited integration with existing Channel Archiver data sources.</li>
 </ul>
 </section>

diff --git a/docs/images/csstudio_config.png b/docs/images/csstudio_config.png
diff --git a/docs/images/csstudio_plot.jpg b/docs/images/csstudio_plot.jpg
diff --git a/docs/userguide.html b/docs/userguide.html
@@ -86,8 +86,9 @@ <h3>Adding a PV to be archived.</h3>
 </section>
 
 <section id="retrieval">
-<h3>Retrieving data using Archive Viewer and Matlab</h3>
+<h3>Retrieving data using CS-Studio, Archive Viewer and Matlab</h3>
 <ol>
+<li>To retrieve data using the CS-Studio, see the <a href="csstudio.html">CS-Studio</a> section.</li>
 <li>To retrieve data using the Archive Viewer, see the <a href="archiveviewer.html">Archive Viewer</a> section.</li>
 <li>To retrieve data using Matlab, see the <a href="matlab.html">Matlab</a> section.</li>
 </ol>