feat: Geutebruck GeViScope/GeViSoft Action Mapping System - MVP
This MVP release provides a complete full-stack solution for managing action mappings in Geutebruck's GeViScope and GeViSoft video surveillance systems. ## Features ### Flutter Web Application (Port 8081) - Modern, responsive UI for managing action mappings - Action picker dialog with full parameter configuration - Support for both GSC (GeViScope) and G-Core server actions - Consistent UI for input and output actions with edit/delete capabilities - Real-time action mapping creation, editing, and deletion - Server categorization (GSC: prefix for GeViScope, G-Core: prefix for G-Core servers) ### FastAPI REST Backend (Port 8000) - RESTful API for action mapping CRUD operations - Action template service with comprehensive action catalog (247 actions) - Server management (G-Core and GeViScope servers) - Configuration tree reading and writing - JWT authentication with role-based access control - PostgreSQL database integration ### C# SDK Bridge (gRPC, Port 50051) - Native integration with GeViSoft SDK (GeViProcAPINET_4_0.dll) - Action mapping creation with correct binary format - Support for GSC and G-Core action types - Proper Camera parameter inclusion in action strings (fixes CrossSwitch bug) - Action ID lookup table with server-specific action IDs - Configuration reading/writing via SetupClient ## Bug Fixes - **CrossSwitch Bug**: GSC and G-Core actions now correctly display camera/PTZ head parameters in GeViSet - Action strings now include Camera parameter: `@ PanLeft (Comment: "", Camera: 101028)` - Proper filter flags and VideoInput=0 for action mappings - Correct action ID assignment (4198 for GSC, 9294 for G-Core PanLeft) ## Technical Stack - **Frontend**: Flutter Web, Dart, Dio HTTP client - **Backend**: Python FastAPI, PostgreSQL, Redis - **SDK Bridge**: C# .NET 8.0, gRPC, GeViSoft SDK - **Authentication**: JWT tokens - **Configuration**: GeViSoft .set files (binary format) ## Credentials - GeViSoft/GeViScope: username=sysadmin, password=masterkey - Default admin: username=admin, password=admin123 ## Deployment All services run on localhost: - Flutter Web: http://localhost:8081 - FastAPI: http://localhost:8000 - SDK Bridge gRPC: localhost:50051 - GeViServer: localhost (default port) Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Administrator
@@ -0,0 +1,43 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>ACS access denied</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">ATM / ACS</span>
|
||||
</div>
|
||||
<h1 class="Mitte">ATM / ACS</h1>
|
||||
<p> </p>
|
||||
<h2 class="Mitte"><a name="ACS"></a>ACS access denied</h2>
|
||||
<p> </p>Action name:<i>ACSAccessDenied(ACSName, ACSNo, Account, BancCode, CardNo, TimeStamp, Reason)</i>Action category: logical
|
||||
ACS access denied.
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0"><col class="Column-Column1" /><col class="Column-Column1" /><col class="Column-Column1" /><thead><tr class="Head-Header1"><th colspan="2" class="HeadE-Column1-Header1">Parameter</th><th class="HeadD-Column1-Header1">Function</th></tr></thead><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">ACS</td><td width="72px" class="BodyE-Column1-Body1"><i>ACSName</i></td><td width="77px" class="BodyD-Column1-Body1">ACS name.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">ACS no</td><td width="72px" class="BodyE-Column1-Body2"><i>ACSNo</i></td><td width="77px" class="BodyD-Column1-Body2">ACS no.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">account</td><td width="72px" class="BodyE-Column1-Body1"><i>Account</i></td><td width="77px" class="BodyD-Column1-Body1">Account no.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">bank code</td><td width="72px" class="BodyE-Column1-Body2"><i>BancCode</i></td><td width="77px" class="BodyD-Column1-Body2">Bank code.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">card no</td><td width="72px" class="BodyE-Column1-Body1"><i>CardNo</i></td><td width="77px" class="BodyD-Column1-Body1">Card no.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">time stamp</td><td width="72px" class="BodyE-Column1-Body2"><i>TimeStamp</i></td><td width="77px" class="BodyD-Column1-Body2">Time stamp.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">reason</td><td width="72px" class="BodyE-Column1-Body1"><i>Reason</i></td><td width="77px" class="BodyD-Column1-Body1">Reason.</td></tr></table><p> </p><div id="nsr" class="header"><h2 class="Mitte"><a name="ACS2"></a>ACS access granted</h2><p> </p></div><div id="text" class="content">Action name:<i>ACSAccessGranted(ACSName, ACSNo, Account, BancCode, CardNo, TimeStamp)</i>Action category: logical
|
||||
</div><div class="content">ACS access granted.
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" cellspacing="0" class="TableStyle-Rows"><col class="Column-Column1" /><col class="Column-Column1" /><col class="Column-Column1" /><thead><tr class="Head-Header1"><th class="HeadE-Column1-Header1" colspan="2">Parameter</th><th class="HeadD-Column1-Header1">Function</th></tr></thead><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">ACS</td><td width="72px" class="BodyE-Column1-Body1"><i>ACSName</i></td><td width="77px" class="BodyD-Column1-Body1">ACS name.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">ACS no</td><td width="72px" class="BodyE-Column1-Body2"><i>ACSNo</i></td><td width="77px" class="BodyD-Column1-Body2">ACS no.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">account</td><td width="72px" class="BodyE-Column1-Body1"><i>Account</i></td><td width="77px" class="BodyD-Column1-Body1">Account no.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">bank code</td><td width="72px" class="BodyE-Column1-Body2"><i>BancCode</i></td><td width="77px" class="BodyD-Column1-Body2">Bank code.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">card no</td><td width="72px" class="BodyE-Column1-Body1"><i>CardNo</i></td><td width="77px" class="BodyD-Column1-Body1">Card no.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">time stamp</td><td width="72px" class="BodyE-Column1-Body2"><i>TimeStamp</i></td><td width="77px" class="BodyD-Column1-Body2">Time stamp.</td></tr></table><p> </p></div><h2 class="Mitte"><a name="ACS3"></a>ACS raw answer</h2><p> </p>Action name:<i>ACSRawAnswer(ACSName, TimeStamp, ACSData)</i>Action category: logical
|
||||
ACS raw answer.
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" cellspacing="0" class="TableStyle-Rows"><col class="Column-Column1"></col><col class="Column-Column1"></col><col class="Column-Column1"></col><thead><tr class="Head-Header1"><th class="HeadE-Column1-Header1" colspan="2">Parameter</th><th class="HeadD-Column1-Header1">Function</th></tr></thead><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">ACS</td><td width="72px" class="BodyE-Column1-Body1"><i>ACSName</i></td><td width="82px" class="BodyD-Column1-Body1">ACS name.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">time stamp</td><td width="72px" class="BodyE-Column1-Body2"><i>TimeStamp</i></td><td width="82px" class="BodyD-Column1-Body2">Time stamp.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">answer</td><td width="72px" class="BodyE-Column1-Body1"><i>ACSData</i></td><td width="82px" class="BodyD-Column1-Body1">ACS answer.</td></tr></table><p> </p><h2 class="Mitte"><a name="ACS4"></a>ACS raw data</h2><p> </p>Action name:<i>ACSRawData(ACSName, TimeStamp, ACSData)</i>Action category: logical
|
||||
ACS raw data.
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" cellspacing="0" class="TableStyle-Rows"><col class="Column-Column1"></col><col class="Column-Column1"></col><col class="Column-Column1"></col><thead><tr class="Head-Header1"><th class="HeadE-Column1-Header1" colspan="2">Parameter</th><th class="HeadD-Column1-Header1">Function</th></tr></thead><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">ACS</td><td width="72px" class="BodyE-Column1-Body1"><i>ACSName</i></td><td width="77px" class="BodyD-Column1-Body1">ACS name.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">time stamp</td><td width="72px" class="BodyE-Column1-Body2"><i>TimeStamp</i></td><td width="77px" class="BodyD-Column1-Body2">Time stamp.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">data</td><td width="72px" class="BodyE-Column1-Body1"><i>ACSData</i></td><td width="77px" class="BodyD-Column1-Body1">ACS data.</td></tr></table><p> </p><div id="nsr" class="header"><h2 class="Mitte"><a name="ATM"></a>ATM raw answer</h2><p> </p></div><div id="text" class="content">Action name:<i>ATMRawAnswer(ATMName, TimeStamp, ATMData)</i>Action category: logical
|
||||
ATM raw answer.
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" cellspacing="0" class="TableStyle-Rows"><col class="Column-Column1"></col><col class="Column-Column1"></col><col class="Column-Column1"></col><thead><tr class="Head-Header1"><th class="HeadE-Column1-Header1" colspan="2">Parameter</th><th class="HeadD-Column1-Header1">Function</th></tr></thead><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">ATM</td><td width="72px" class="BodyE-Column1-Body1"><i>ATMName</i></td><td width="83px" class="BodyD-Column1-Body1">ATM name.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">time stamp</td><td width="72px" class="BodyE-Column1-Body2"><i>TimeStamp</i></td><td width="83px" class="BodyD-Column1-Body2">Time stamp.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">answer</td><td width="72px" class="BodyE-Column1-Body1"><i>ATMData</i></td><td width="83px" class="BodyD-Column1-Body1">ATM answer.</td></tr></table><p> </p></div><h2 class="Mitte"><a name="ATM2"></a>ATM raw data</h2><p> </p>Action name:<i>ATMRawData(ATMName, TimeStamp, ATMData)</i>Action category: logical
|
||||
ATM raw data.
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" cellspacing="0" class="TableStyle-Rows"><col class="Column-Column1"></col><col class="Column-Column1"></col><col class="Column-Column1"></col><thead><tr class="Head-Header1"><th class="HeadE-Column1-Header1" colspan="2">Parameter</th><th class="HeadD-Column1-Header1">Function</th></tr></thead><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">ATM</td><td width="72px" class="BodyE-Column1-Body1"><i>ATMName</i></td><td width="77px" class="BodyD-Column1-Body1">ATM name.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="69px" class="BodyE-Column1-Body2">time stamp</td><td width="72px" class="BodyE-Column1-Body2"><i>TimeStamp</i></td><td width="77px" class="BodyD-Column1-Body2">Time stamp.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="69px" class="BodyE-Column1-Body1">data</td><td width="72px" class="BodyE-Column1-Body1"><i>ATMData</i></td><td width="77px" class="BodyD-Column1-Body1">ATM data.</td></tr></table><p> </p><h2 class="Mitte"><a name="ATM3"></a>ATM transaction</h2><p> </p>Action name:<i>ATMTransaction(ATMName, NewTransaction, Photostep, ATMNo, Account, BancCode, CardNo, TAN1, TAN2, TimeStamp1, TimeStamp2, Amount, Currency)</i>Action category: logical
|
||||
ATM transaction.
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" cellspacing="0" class="TableStyle-Rows"><col class="Column-Column1"></col><col class="Column-Column1"></col><col class="Column-Column1"></col><thead><tr class="Head-Header1"><th class="HeadE-Column1-Header1" colspan="2">Parameter</th><th class="HeadD-Column1-Header1">Function</th></tr></thead><tr align="left" valign="top" class="Body-Body1"><td width="97px" class="BodyE-Column1-Body1">ATM</td><td width="100px" class="BodyE-Column1-Body1"><i>ATMName</i></td><td width="103px" class="BodyD-Column1-Body1">ATM name.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="97px" class="BodyE-Column1-Body2">new transaction</td><td width="100px" class="BodyE-Column1-Body2"><i>NewTransaction</i></td><td width="103px" class="BodyD-Column1-Body2">New transaction.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="97px" class="BodyE-Column1-Body1">photostep</td><td width="100px" class="BodyE-Column1-Body1"><i>Photostep</i></td><td width="103px" class="BodyD-Column1-Body1">Photostep.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="97px" class="BodyE-Column1-Body2">ATM no</td><td width="100px" class="BodyE-Column1-Body2"><i>ATMNo</i></td><td width="103px" class="BodyD-Column1-Body2">ATM no.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="97px" class="BodyE-Column1-Body1">account</td><td width="100px" class="BodyE-Column1-Body1"><i>Account</i></td><td width="103px" class="BodyD-Column1-Body1">Account no.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="97px" class="BodyE-Column1-Body2">bank code</td><td width="100px" class="BodyE-Column1-Body2"><i>BancCode</i></td><td width="103px" class="BodyD-Column1-Body2">Bank code.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="97px" class="BodyE-Column1-Body1">card no</td><td width="100px" class="BodyE-Column1-Body1"><i>CardNo</i></td><td width="103px" class="BodyD-Column1-Body1">Card no.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="97px" class="BodyE-Column1-Body2">tan 1</td><td width="100px" class="BodyE-Column1-Body2"><i>TAN1</i></td><td width="103px" class="BodyD-Column1-Body2">TAN 1.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="97px" class="BodyE-Column1-Body1">tan 2</td><td width="100px" class="BodyE-Column1-Body1"><i>TAN2</i></td><td width="103px" class="BodyD-Column1-Body1">TAN 2.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="97px" class="BodyE-Column1-Body2">time stamp 1</td><td width="100px" class="BodyE-Column1-Body2"><i>TimeStamp1</i></td><td width="103px" class="BodyD-Column1-Body2">Time stamp 1.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="97px" class="BodyE-Column1-Body1">time stamp 2</td><td width="100px" class="BodyE-Column1-Body1"><i>TimeStamp2</i></td><td width="103px" class="BodyD-Column1-Body1">Time stamp 2.</td></tr><tr align="left" valign="top" class="Body-Body2"><td width="97px" class="BodyE-Column1-Body2">amount</td><td width="100px" class="BodyE-Column1-Body2"><i>Amount</i></td><td width="103px" class="BodyD-Column1-Body2">Amount.</td></tr><tr align="left" valign="top" class="Body-Body1"><td width="97px" class="BodyE-Column1-Body1">currency</td><td width="100px" class="BodyE-Column1-Body1"><i>Currency</i></td><td width="103px" class="BodyD-Column1-Body1">Currency.</td></tr></table><p> </p><p> </p></body>
|
||||
</html>
|
||||
@@ -0,0 +1,117 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Audio control</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Audio control</span>
|
||||
</div>
|
||||
<h1 class="Mitte">Audio control</h1>
|
||||
<p id="text">All actions to control the audio streams, also all notifications about the state change of the audio streams.</p>
|
||||
<p> </p>
|
||||
<h2 class="Mitte"><a name="ABC"></a>ABC connect</h2>
|
||||
<div id="text" class="content">Action name:<i>ABCConnect(Address)</i>Action category: logical
|
||||
Connect audio back channel.</div>
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1">
|
||||
</col>
|
||||
<col class="Column-Column1">
|
||||
</col>
|
||||
<col class="Column-Column1">
|
||||
</col>
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th colspan="2" class="HeadE-Column1-Header1">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr align="left" valign="top" class="Body-Body1">
|
||||
<td width="51px" class="BodyE-Column1-Body1">address</td>
|
||||
<td width="53px" class="BodyE-Column1-Body1"><i>Address</i>
|
||||
</td>
|
||||
<td width="180px" class="BodyD-Column1-Body1">Address of the remote server.</td>
|
||||
</tr>
|
||||
<tr height="0px" class="Body-Body2">
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<h2 class="Mitte"><a name="ABC2"></a>ABC disconnect</h2>
|
||||
<div id="text" class="content">Action name:<i>ABCDisconnect()</i>Action category: logical
|
||||
Disconnect audio back channel.</div>
|
||||
<p> </p>
|
||||
<h2 class="Mitte"><a name="ABC3"></a>ABC play file</h2>
|
||||
<div id="text" class="content">Action name:<i>ABCPlayFile(FileID, FileName, AutoRepeat)</i>Action category: logical
|
||||
Play file on audio back channel.</div>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1">
|
||||
</col>
|
||||
<col class="Column-Column1">
|
||||
</col>
|
||||
<col class="Column-Column1">
|
||||
</col>
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th colspan="2" class="HeadE-Column1-Header1">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr align="left" valign="top" class="Body-Body1">
|
||||
<td width="58px" class="BodyE-Column1-Body1">file id</td>
|
||||
<td width="74px" class="BodyE-Column1-Body1"><i>FileID</i>
|
||||
</td>
|
||||
<td width="149px" class="BodyD-Column1-Body1">File ID.</td>
|
||||
</tr>
|
||||
<tr align="left" valign="top" class="Body-Body2">
|
||||
<td width="58px" class="BodyE-Column1-Body2">file name</td>
|
||||
<td width="74px" class="BodyE-Column1-Body2"><i>FileName</i>
|
||||
</td>
|
||||
<td width="149px" class="BodyD-Column1-Body2">Name of the file.</td>
|
||||
</tr>
|
||||
<tr align="left" valign="top" class="Body-Body1">
|
||||
<td width="58px" class="BodyE-Column1-Body1">repeat</td>
|
||||
<td width="74px" class="BodyE-Column1-Body1"><i>AutoRepeat</i>
|
||||
</td>
|
||||
<td width="149px" class="BodyD-Column1-Body1">Repeat file automatically</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<h2 class="Mitte"><a name="Sensor"></a>Sensor audio alarm</h2>
|
||||
<div id="text" class="content">Action name:<i>SensorAudioAlarm(Channel)</i>Action category: logical
|
||||
Audio alarm detected.</div>
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th colspan="2" class="HeadE-Column1-Header1">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr align="left" valign="top" class="Body-Body1">
|
||||
<td width="51px" class="BodyE-Column1-Body1">channel</td>
|
||||
<td width="54px" class="BodyE-Column1-Body1"><i>Channel</i>
|
||||
</td>
|
||||
<td width="60px" class="BodyD-Column1-Body1">Channel.</td>
|
||||
</tr>
|
||||
<tr height="0px" class="Body-Body2" />
|
||||
</table>
|
||||
<p> </p>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,567 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Cash management actions</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Cash management actions</span>
|
||||
</div>
|
||||
<h1>Cash management actions</h1>
|
||||
<p>Cash Management Actions offer the exchange of accompanying meta data between Cash Management Systems and GeViScope/Re_porter. With these actions money handling processes can be documented consistently via video. The use of these actions for starting and restarting of event recordings leads to the display of the accompanying video data in live streams of GscView and the storage of those in the video database. The video sequences recorded by Cash Management Actions can later be recovered easily in GscView by using the accompanying meta data and a special data filter dialog.</p>
|
||||
<p> </p>
|
||||
<h2><a name="Safebag"></a>Safebag close</h2>
|
||||
<p>Action name:SafebagClose(WorkingPlace, StartTime, StopTime, SafebagNo, SafebagInfo, StepID, Debit, Total, Difference, HasDifference, Notes, Coins, Cheques)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Safebag close.</p>
|
||||
<p>The integrated Cash Management System sends the action as soon as the user has finished the counting of one safe bag and has confirmed that to the Cash Management System .</p>
|
||||
<p>Via the parameter "working place" the affected working place will be identified. The further parameter will be provided with accompanying video data by Cash Management System.</p>
|
||||
<p>The parameter "StepID" can be provided with a code figure by the Cash Management System for the currently running process step.</p>
|
||||
<p> </p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">working place
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">WorkingPlace
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Working place no.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">start time </td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">StartTime
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp, when the handling of the safe bag began. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">stop time </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">StopTime
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp, when the handling of the safe bag stopped. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">safebag no.
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">SafebagNo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Alphanumerical identification of safe bag; search criteria in GscView </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">safebag info
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">SafebagInfo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Additional alphanumerical identification of safe bag </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">step id
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">StepID
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Code figure for the currently running process step (given by Cash Management System individually) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">debit
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Debit
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Debit amount of safebag </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">total
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Total
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Effective total amount of safe bag according to counting (will be accumulated by Cash Management Systems on counting) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">difference
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Difference
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Difference between total amount and result respectively progress of counting</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">has difference
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">HasDifference
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Yes = current total amount has a difference to debit amount
|
||||
<br />No = current total amount is identical with debit amount
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">notes
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Notes
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Denomination of counted banknotes. The Display in GscView is in table form. The table has max. 2 columns. The individual lines can be separated via insertion of control '\r' (0x0D). The separation of both columns within one line can be carried out via insertion of control '\t' (0x09). </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">coins
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Coins
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Denomination of counted coins. The Display in GscView is in table form. The table has max. 2 columns. The individual lines can be separated via insertion of control '\r' (0x0D). The separation of both columns within one line can be carried out via insertion of control '\t' (0x09). </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">cheques
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Cheques
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Denomination of counted cheques. The Display in GscView is in table form. The table has max. 2 columns. The individual lines can be separated via insertion of control '\r' (0x0D). The separation of both columns within one line can be carried out via insertion of control '\t' (0x09). </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Safebag2"></a>Safebag data</h2>
|
||||
<p>Action name:SafebagData(WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID, Debit, Total, Difference, HasDifference, Notes, Coins, Cheques)</p>
|
||||
<p>Action category: command</p>
|
||||
<p>Safebag data.</p>
|
||||
<p>The integrated Cash Management System sends the action as soon as the user has finished counting one variety of notes or coins and has confirmed that to the system.</p>
|
||||
<p>Via the parameter "working place" the affected working place will be identified. The further parameter will be provided with accompanying meta data by the Cash Management System.</p>
|
||||
<p>The parameter "StepID" can be provided with a code figure by the Cash Management System for the currently running process step.</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">working place
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">WorkingPlace
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Working place no.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">start time </td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">StartTime
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp, when the handling of the safe bag began. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">safebag no.
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">SafebagNo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of safe bag; search criteria in GscView </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">safebag info
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">SafebagInfo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Additional alphanumerical identification of safe bag</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">step id
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">StepID
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Code figure for the currently running process step (given by cash management system individually </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">debit
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Debit
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Debit amount of safe bag </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">total
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Total
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Effective total amount of safe bag according to counting ( will be accumulated by the Cash management System during counting) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">difference
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Difference
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Difference between total amount and result respectively progress of counting</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">has difference
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">HasDifference
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Yes = current total amount has a difference to debit amount
|
||||
<br />No = current total amount is identical with debit amount
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">notes
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Notes
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Denomination of counted banknotes. The Display in GscView is in table form. The table has max. 2 columns. The individual lines can be separated via insertion of control '\r' (0x0D). The separation of both columns within one line can be carried out via insertion of control '\t' (0x09). </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">coins
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Coins
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Denomination of counted coins. The Display in GscView is in table form. The table has max. 2 columns. The individual lines can be separated via insertion of control '\r' (0x0D). The separation of both columns within one line can be carried out via insertion of control '\t' (0x09). </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">cheques
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Cheques
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Denomination of counted cheques. The Display in GscView is in table form. The table has max. 2 columns. The individual lines can be separated via insertion of control '\r' (0x0D). The separation of both columns within one line can be carried out via insertion of control '\t' (0x09). </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Safebag3"></a>Safebag open</h2>
|
||||
<p>Action name:SafebagOpen(WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p>Safebag open.</p>
|
||||
<p>The integrated Cash Management System sends the action as soon as the user has opened the safe bag and confirmed that with an entry in the Cash Management System.</p>
|
||||
<p>The affected Working Place will be identified via the parameter "Working place". Further parameters will be filled with accompanying meta data on the part of the Cash Management System.</p>
|
||||
<p>The Parameter "StepID" can be addressed by the Cash Management System with a code figure for the currently running process step.</p>
|
||||
<p> </p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">working place
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">WorkingPlace
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Working place no.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">start time </td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">StartTime
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp, when the handling of the safe bag began. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">safebag no.
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">SafebagNo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of safe bag; search criteria in GscView </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">safebag info
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">SafebagInfo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Additional alphanumerical identification of safe bag</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">step id
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">StepID
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Code figure for the currently running process step (given by cash management system individually </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Safebag4"></a>Safebag passing of risk data</h2>
|
||||
<p>Action name:SafebagPassingOfRiskData(WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID, UserID1, UserID2, TourNumber, TargetWorkingPlace, PassingOfRiskType)
|
||||
|
||||
</p>
|
||||
<p>Action category: command
|
||||
|
||||
</p>
|
||||
<p>The integrated Cash Management System sends the action continuously for each safe bag while the amount of safe bags between two employees will be transferred and this will be confirmed to the Cash Management System. This part of the money handling process is a "passing of risk".
|
||||
|
||||
Via the parameter "working place" the affected transfer place and respectively the working place will be identified. The further parameters will be filled with accompanying video data by the Cash Management System.
|
||||
|
||||
The parameter "StepID" can be provided with a code figure by the Cash Management System for the currently running process step. </p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">working place
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">WorkingPlace
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Working place no.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">start time </td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">StartTime
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp, when the handling of the safe bag began. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">safebag no.
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">SafebagNo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of safe bag; search criteria in GscView </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">safebag info
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">SafebagInfo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Additional alphanumerical identification of safe bag</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">step id
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">StepID
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Code figure for the currently running process step (given by cash management system individually </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">user 1</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">UserID1</td>
|
||||
<td class="BodyD-Column1-Body2">Number of employee, transferring the safe bag to another employee.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">user 2</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">UserID2</td>
|
||||
<td class="BodyD-Column1-Body1">Number of employee, who receives the safe bag from another employee.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">tour no</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TourNumber</td>
|
||||
<td class="BodyD-Column1-Body2">Tour-Number (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">target working place</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">TargetWorkingPlace</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of a place respectively a working place where safe bags will be transferred to (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">passing of risk type</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">PassingOfRiskType</td>
|
||||
<td class="BodyD-Column1-Body2">Detailed information to "passing of risk" (optional) </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Safebag5"></a>Safebag passing of risk start</h2>
|
||||
<p>Action name:SafebagPassingOfRiskStart(WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID, UserID1, UserID2, TourNumber, TargetWorkingPlace, PassingOfRiskType)
|
||||
|
||||
</p>
|
||||
<p>Action category: command
|
||||
|
||||
</p>
|
||||
<p>The integrated Cash Management System sends the action as soon as a number of safe bags will be transferred between two employees and this is confirmed to the Cash Management System. This part of the money handling process is a "passing of risk".
|
||||
|
||||
Via the parameter "working place" the affected transfer place and respectively the working place will be identified. The further parameters will be filled with accompanying meta data by the Cash Management System.
|
||||
|
||||
The parameter "StepID" can be provided with a code figure by the Cash Management System for the currently running process step. </p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">working place
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">WorkingPlace
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Working place no.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">start time </td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">StartTime
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp, when the handling of the safe bag began. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">safebag no.
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">SafebagNo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of safe bag; search criteria in GscView </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">safebag info
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">SafebagInfo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Additional alphanumerical identification of safe bag</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">step id
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">StepID
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Code figure for the currently running process step (given by cash management system individually </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">user 1</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">UserID1</td>
|
||||
<td class="BodyD-Column1-Body2">Number of employee, transferring the safe bag to another employee.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">user 2</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">UserID2</td>
|
||||
<td class="BodyD-Column1-Body1">Number of employee, who receives the safe bag from another employee.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">tour no</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TourNumber</td>
|
||||
<td class="BodyD-Column1-Body2">Tour-Number (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">target working place</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">TargetWorkingPlace</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of a place respectively a working place where safe bags will be transferred to (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">passing of risk type</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">PassingOfRiskType</td>
|
||||
<td class="BodyD-Column1-Body2">Detailed information to "passing of risk" (optional) </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Safebag6"></a>Safebag passing of risk stop</h2>
|
||||
<p>Action name:SafebagPassingOfRiskStop(WorkingPlace, StartTime, StopTime, SafebagNo, SafebagInfo, StepID, UserID1, UserID2, TourNumber, TargetWorkingPlace, PassingOfRiskType)
|
||||
|
||||
</p>
|
||||
<p>Action category: command
|
||||
|
||||
</p>
|
||||
<p>The integrated Cash Management System sends the action closing after the last safe bag, while the number of safe bags will be transferred between two employees and this is confirmed to the Cash Management System. This part of the money handling process is a "passing of risk".
|
||||
|
||||
Via the parameter "Working place" the affected transfer place respective working place will be identified. The further parameters will be filled with accompanying video data by the Cash Management System.
|
||||
|
||||
The parameter "StepID" can be supplied by Cash Management System with a code figure for a currently running process step
|
||||
|
||||
</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">working place
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">WorkingPlace
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Working place no.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">start time </td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">StartTime
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp, when the handling of the safe bag began. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">safebag no.
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">SafebagNo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of safe bag; search criteria in GscView </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">safebag info
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">SafebagInfo
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Additional alphanumerical identification of safe bag</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">step id
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">StepID
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Code figure for the currently running process step (given by cash management system individually </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">user 1</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">UserID1</td>
|
||||
<td class="BodyD-Column1-Body2">Number of employee, transferring the safe bag to another employee.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">user 2</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">UserID2</td>
|
||||
<td class="BodyD-Column1-Body1">Number of employee, who receives the safe bag from another employee.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">tour no</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TourNumber</td>
|
||||
<td class="BodyD-Column1-Body2">Tour-Number (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">target working place</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">TargetWorkingPlace</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of a place respectively a working place where safe bags will be transferred to (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">passing of risk type</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">PassingOfRiskType</td>
|
||||
<td class="BodyD-Column1-Body2">Detailed information to "passing of risk" (optional) </td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,268 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Device information</title>
|
||||
<link href="../Resources/TableStyles/Rows.css" rel="stylesheet" />
|
||||
<style>
|
||||
body
|
||||
{
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Device information</h1>
|
||||
<p>All actions for low-level notification of the device or media channels changes.</p>
|
||||
<h2>Device found</h2>
|
||||
<p>Action name:<i>DeviceFound(Type, Name, Serial)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device is connected to the system. It is also fired at start-up for all detected devices.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">device type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Type</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device name</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Name</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Device name if assigned in setup, empty otherwise.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">serial ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Serial</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Serial ID of the device.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>New firmware received</h2>
|
||||
<p>Action name:<i>DeviceNewFirmware(Type, Name, Serial, Firmware)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device has got the new firmware.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">device type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Type</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device name</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Name</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Device name if assigned in setup, empty otherwise.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">serial ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Serial</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Serial ID of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">firmware serial</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Firmware</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Serial ID of the firmware.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Device plugin error</h2>
|
||||
<p>Action name:<i>DevicePluginError(Channel, Type, SubType, Name, Serial, ErrorClass, ErrorCode, Description)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action notifies device plugin error.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">channel</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Channel</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device type</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Type</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">device sub type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>SubType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Sub type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device name</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Name</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Device name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">serial ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Serial</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Serial ID of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">error class</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ErrorClass</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Error class of the error occured.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">error code</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ErrorCode</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Plugin type specific error code.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">description</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Description</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Error description.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Device plugin state</h2>
|
||||
<p>Action name:<i>DevicePluginState(Channel, Type, SubType, Name, Serial, State, InternalState, Description)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action notifies device plugin state.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">channel</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Channel</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device type</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Type</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">device sub type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>SubType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Sub type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device name</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Name</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Device name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">serial ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Serial</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Serial ID of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">plugin state</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>State</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">New plugin device state.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">internal state</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>InternalState</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Plugin device specific state.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">description</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Description</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">State description.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Device reattached</h2>
|
||||
<p>Action name:<i>DeviceReattached(Type, Name, Serial)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device is reattached to the system.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">device type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Type</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device name</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Name</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Device name if assigned in setup, empty otherwise.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">serial ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Serial</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Serial ID of the device.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Device removed</h2>
|
||||
<p>Action name:<i>DeviceRemoved(Type, Name, Serial)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device is disconnected from the system. It is also fired at the start-up for all parameterized but not present devices.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">device type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Type</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Type of the device.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">device name</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Name</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Device name if assigned in setup, empty otherwise.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">serial ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Serial</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Serial ID of the device.</td>
|
||||
</tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,365 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Device information</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Device information</span>
|
||||
</div>
|
||||
<h1>Device information</h1>
|
||||
<p>All actions for low-level notification of the device or media channels changes.</p>
|
||||
<p> </p>
|
||||
<h2><a name="Device"></a>Device found</h2>
|
||||
<p>Action name:DeviceFound(Type, Name, Serial)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device is connected to the system. It is also fired at start-up for all detected devices.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Type
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device name
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Name
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Device name if assigned in setup, empty otherwise.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">serial ID
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Serial
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Serial ID of the device.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="New"></a>New firmware received</h2>
|
||||
<p>Action name:DeviceNewFirmware(Type, Name, Serial, Firmware)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device has got the new firmware.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Type
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device name
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Name
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Device name if assigned in setup, empty otherwise.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">serial ID
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Serial
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Serial ID of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">firmware serial
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Firmware
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Serial ID of the firmware.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Device2"></a>Device plugin error</h2>
|
||||
<p>Action name:DevicePluginError(Channel, Type, SubType, Name, Serial, ErrorClass, ErrorCode, Description)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action notifies device plugin error.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">channel
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Channel
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Channel.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Type
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device sub type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">SubType
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Sub type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device name
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Name
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Device name.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">serial ID
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Serial
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Serial ID of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">error class
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">ErrorClass
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Error class of the error occured.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">error code
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">ErrorCode
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Plugin type specific error code.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">description
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Description
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Error description.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Device3"></a>Device plugin state</h2>
|
||||
<p>Action name:DevicePluginState(Channel, Type, SubType, Name, Serial, State, InternalState, Description)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action notifies device plugin state.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">channel
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Channel
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Channel.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Type
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device sub type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">SubType
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Sub type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device name
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Name
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Device name.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">serial ID
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Serial
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Serial ID of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">plugin state
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">State
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">New plugin device state.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">internal state
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">InternalState
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Plugin device specific state.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">description
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Description
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">State description.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Device4"></a>Device reattached</h2>
|
||||
<p>Action name:DeviceReattached(Type, Name, Serial)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device is reattached to the system.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Type
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device name
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Name
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Device name if assigned in setup, empty otherwise.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">serial ID
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Serial
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Serial ID of the device.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Device5"></a>Device removed</h2>
|
||||
<p>Action name:DeviceRemoved(Type, Name, Serial)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the USB or NET device is disconnected from the system. It is also fired at the start-up for all parameterized but not present devices.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device type
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Type
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Type of the device.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device name
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">Name
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Device name if assigned in setup, empty otherwise.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">serial ID
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Serial
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Serial ID of the device.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,271 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Digital contacts</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Digital contacts</span>
|
||||
</div>
|
||||
<h1>Digital contacts</h1>
|
||||
<p>All actions for handling digital inputs and outputs.</p>
|
||||
<p> </p>
|
||||
<h2><a name="Digital"></a>Digital input</h2>
|
||||
<p>Action name:DigitalInput(Contact, State)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the state of the digital input has changed.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">contact
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Contact
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Contact.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">state
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">State
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">New state.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="IOI43"></a>IOI43 reset mainboard</h2>
|
||||
<p>Action name:IOI43ResetMainboard()</p>
|
||||
<p>Action category: logical</p>
|
||||
<p> </p>
|
||||
<p>Reset mainboard using IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2><a name="IOI432"></a>IOI43 temperature notification</h2>
|
||||
<p>Action name:IOI43Temperature(ID, Temperature)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p> </p>
|
||||
<p>Temperature notification from IOI43a/ab USB Alarm-I/O.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">ID </td>
|
||||
<td class="BodyE-Column1-Body1">ID </td>
|
||||
<td class="BodyD-Column1-Body1">ID of the IOI43 module (like IOI43-00).
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">temperature </td>
|
||||
<td class="BodyE-Column1-Body2">Temperature </td>
|
||||
<td class="BodyD-Column1-Body2">Temperature.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="IOI433"></a>IOI43 watchdog activate</h2>
|
||||
<p>Action name:IOI43WDActivate()</p>
|
||||
<p>Action category: logical</p>
|
||||
<p> </p>
|
||||
<p>Activate watchdog on IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2><a name="IOI434"></a>IOI43 watchdog deactivate</h2>
|
||||
<p>Action name:IOI43WDDeactivate()</p>
|
||||
<p>Action category: logical</p>
|
||||
<p> </p>
|
||||
<p>Deactivate watchdog on IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2><a name="IOI435"></a>IOI43 watchdog trigger</h2>
|
||||
<p>Action name:IOI43WDTrigger()</p>
|
||||
<p>Action category: logical</p>
|
||||
<p> </p>
|
||||
<p>Trigger watchdog on IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2><a name="Key"></a>Key pressed</h2>
|
||||
<p>Action name:KeyPressed(Key)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is notified if one of the GEVISCOPE system keys is pressed.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Key
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Key
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">System key.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Key2"></a>Key released</h2>
|
||||
<p>Action name:KeyReleased(Key)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is notified if one of the GEVISCOPE system keys is released.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Key
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Key
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">System key.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Set"></a>Set digital output</h2>
|
||||
<p>Action name:SetDigitalOutput(Contact, State)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is used to modify the state of the digital output and to notify this change.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">contact
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">Contact
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Contact.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">state
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">State
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">New state.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Set2"></a>Set system LED</h2>
|
||||
<p>Action name:SetLED(LED, State)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is used to turn the system LEDs on or off.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">LED
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">LED
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">System LED.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">state
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">State
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">New state.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Set3"></a>Set system LED to blink</h2>
|
||||
<p>Action name:SetLEDBlink(LED, LedTimeOnMs, LedTimeOffMs)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is used to blink the system LEDs.</p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">LED
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">LED
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">System LED.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">Led time ON
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2">LedTimeOnMs
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time in milliseconds the LED will be switched on.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Led time OFF
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1">LedTimeOffMs
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time in milliseconds the LED will be switched off.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,198 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Digital contacts</title>
|
||||
<link href="../Resources/TableStyles/Rows.css" rel="stylesheet" />
|
||||
<style>
|
||||
body
|
||||
{
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Digital contacts</h1>
|
||||
<p>All actions for handling digital inputs and outputs.</p>
|
||||
<h2>Digital input</h2>
|
||||
<p>Action name:<i>DigitalInput(Contact, State)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action will be fired when the state of the digital input has changed.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">contact</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Contact</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Contact.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">state</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>State</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">New state.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>IOI43 reset mainboard</h2>
|
||||
<p>Action name:<i>IOI43ResetMainboard()</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Reset mainboard using IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2>IOI43 temperature notification</h2>
|
||||
<p>Action name:<i>IOI43Temperature(ID, Temperature)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Temperature notification from IOI43a/ab USB Alarm-I/O.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ID</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">ID of the IOI43 module (like IOI43-00).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">temperature</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Temperature</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Temperature.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>IOI43 watchdog activate</h2>
|
||||
<p>Action name:<i>IOI43WDActivate()</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Activate watchdog on IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2>IOI43 watchdog deactivate</h2>
|
||||
<p>Action name:<i>IOI43WDDeactivate()</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Deactivate watchdog on IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2>IOI43 watchdog trigger</h2>
|
||||
<p>Action name:<i>IOI43WDTrigger()</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Trigger watchdog on IOI43a/ab USB Alarm-I/O.</p>
|
||||
<h2>Key pressed</h2>
|
||||
<p>Action name:<i>KeyPressed(Key)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is notified if one of the GEVISCOPE system keys is pressed.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">Key</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Key</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">System key.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Key released</h2>
|
||||
<p>Action name:<i>KeyReleased(Key)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is notified if one of the GEVISCOPE system keys is released.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">Key</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Key</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">System key.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Set digital output</h2>
|
||||
<p>Action name:<i>SetDigitalOutput(Contact, State)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is used to modify the state of the digital output and to notify this change.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">contact</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Contact</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Contact.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">state</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>State</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">New state.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Set system LED</h2>
|
||||
<p>Action name:<i>SetLED(LED, State)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is used to turn the system LEDs on or off.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">LED</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>LED</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">System LED.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">state</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>State</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">New state.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Set system LED to blink</h2>
|
||||
<p>Action name:<i>SetLEDBlink(LED, LedTimeOnMs, LedTimeOffMs)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>This action is used to blink the system LEDs.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">LED</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>LED</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">System LED.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">Led time ON</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>LedTimeOnMs</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Time in milliseconds the LED will be switched on.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">Led time OFF</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>LedTimeOffMs</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Time in milliseconds the LED will be switched off.</td>
|
||||
</tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,169 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>LPS</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<style>
|
||||
body
|
||||
{
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">LPS Local Positioning System</span>
|
||||
</div>
|
||||
<h1>LPS Actions</h1>
|
||||
<p>LPS (Local Positioning System) actions are used to query and receive position data.
|
||||
The positioning system is integrated by the GscLPS plugin and is used to locate tagged objects, e.g. mobile scanners in the logistic environment. The tags have IDs that can be used to query the position which is then notified
|
||||
as cartesian or geografic coordinates. Some tags are able to initiate a position request by an external trigger or by a scan event on a mobile scanner.
|
||||
</p>
|
||||
<h2><a name="LPS"></a>LPS position data</h2>
|
||||
<p>Action name:<i>LPSPositionData(TagID, ScannerID, X, Y, Z, Latitude, Longitude, AreaID, CellID, Status, TimeStamp, Data, AreaName)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>LPS position data.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">tag ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TagID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Tag ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">scanner ID</td>
|
||||
<td class="BodyE-Column1-Body2"><i>ScannerID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Scanner ID or IP Address.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">X coordinate</td>
|
||||
<td class="BodyE-Column1-Body1"><i>X</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">X coordinate of cartesian coordinates.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">Y coordinate</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Y</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Y coordinate of cartesian coordinates.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Z coordinate</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Z</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Z coordinate of cartesian coordinates.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">Latitude</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Latitude</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Latitude of geographic coordinates.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Longitude</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Longitude</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Longitude of geographic coordinates.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">area ID</td>
|
||||
<td class="BodyE-Column1-Body2"><i>AreaID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Area ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">cell ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>CellID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Cell ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">status</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Status</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Status.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">data</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Data</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Data received by the positioning system, eg. barcode.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">area name</td>
|
||||
<td class="BodyB-Column1-Body1"><i>AreaName</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Area Name.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="LPS2"></a>LPS query position</h2>
|
||||
<p>Action name:<i>LPSQueryPosition(TagID, ScannerID, Data)</i></p>
|
||||
<p>Action category: command</p>
|
||||
<p>Send position query for a Tag to LPS server.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">tag ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TagID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Tag ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">scanner ID</td>
|
||||
<td class="BodyE-Column1-Body2"><i>ScannerID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Scanner ID or IP Address.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">data</td>
|
||||
<td class="BodyB-Column1-Body1"><i>Data</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Data.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,590 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Lenel</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<style>
|
||||
<!--
|
||||
body {
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
-->
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Lenel</span>
|
||||
</div>
|
||||
<h1>Lenel</h1>
|
||||
<p>Lenel OnGuard actions.</p>
|
||||
<h2><a name="Lenel"></a>Lenel access event</h2>
|
||||
<p>Action name:<i>LenelAccessEvent(ID, Panel, Device, SecondaryDevice, CardNumber, AccessResult, Type, SubType, Description, SerialNumber, TimeStamp, AreaEnteredID, AreaExitedID, AssetID, CardholderEntered, Duress, ElevatorFloor, FacilityCode, IsReadableCard, IssueCode, CommServerHostName, EventText)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Lenel OnGuard access event.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The ID that uniquely identifies the type of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">panel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Panel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The name of the panel where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Device</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The name of the device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">secondary device</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SecondaryDevice</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The ID of the secondary device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">card number</td>
|
||||
<td class="BodyE-Column1-Body1"><i>CardNumber</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The badge ID for the card that was read, if available.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">access result</td>
|
||||
<td class="BodyE-Column1-Body2"><i>AccessResult</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The level of access that was granted that resulted from reading the card.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">type</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Type</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Event type i.e., duress, system, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">subtype</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SubType</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Event sub-type i.e., granted, door forced open, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">description</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Description</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">A human readable, brief description of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">serial number</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SerialNumber</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">A number that uniquely identifies the instance of the event for a particular panel.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">area entered</td>
|
||||
<td class="BodyE-Column1-Body2"><i>AreaEnteredID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The ID of the area that was entered, if any.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">area exited</td>
|
||||
<td class="BodyE-Column1-Body1"><i>AreaExitedID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The ID of the area that was exited, if any.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">asset ID</td>
|
||||
<td class="BodyE-Column1-Body2"><i>AssetID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The ID of the asset related to this event, if any.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">cardholder entered</td>
|
||||
<td class="BodyE-Column1-Body1"><i>CardholderEntered</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Whether entry was made by the cardholder.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">duress</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Duress</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Indicates whether this card access indicates an under duress/emergency state.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">elevator floor</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ElevatorFloor</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The elevator floor on which the access event was generated, if any.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">facility code</td>
|
||||
<td class="BodyE-Column1-Body2"><i>FacilityCode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The facility code for the card that was read, if available.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">readable card</td>
|
||||
<td class="BodyE-Column1-Body1"><i>IsReadableCard</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Whether the card could be read.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">issue code</td>
|
||||
<td class="BodyE-Column1-Body2"><i>IssueCode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The issue code for the card that was read, if available.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">server host</td>
|
||||
<td class="BodyE-Column1-Body1"><i>CommServerHostName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Host name of the Communication server through which the event arrived.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">event text</td>
|
||||
<td class="BodyB-Column1-Body2"><i>EventText</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">Text associated with event</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="Lenel2"></a>Lenel fire event</h2>
|
||||
<p>Action name:<i>LenelFireEvent(ID, Panel, Device, SecondaryDevice, TroubleCode, Type, SubType, Description, SerialNumber, TimeStamp, CommServerHostName, EventText)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Lenel OnGuard fire event.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The ID that uniquely identifies the type of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">panel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Panel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The name of the panel where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Device</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The name of the device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">secondary device</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SecondaryDevice</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The ID of the secondary device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">trouble code</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TroubleCode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">A trouble code associated with the fire event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">type</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Type</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Event type i.e., duress, system, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">subtype</td>
|
||||
<td class="BodyE-Column1-Body1"><i>SubType</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Event sub-type i.e., granted, door forced open, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">description</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Description</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">A human readable, brief description of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">serial number</td>
|
||||
<td class="BodyE-Column1-Body1"><i>SerialNumber</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">A number that uniquely identifies the instance of the event for a particular panel.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp</td>
|
||||
<td class="BodyE-Column1-Body2"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">server host</td>
|
||||
<td class="BodyE-Column1-Body1"><i>CommServerHostName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Host name of the Communication server through which the event arrived.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">event text</td>
|
||||
<td class="BodyB-Column1-Body2"><i>EventText</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">Text associated with event</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="Lenel3"></a>Lenel intercom event</h2>
|
||||
<p>Action name:<i>LenelIntercomEvent(ID, Panel, Device, SecondaryDevice, IntercomData, LineNumber, Type, SubType, Description, SerialNumber, TimeStamp, CommServerHostName, EventText)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Lenel OnGuard intercom event.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The ID that uniquely identifies the type of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">panel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Panel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The name of the panel where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Device</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The name of the device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">secondary device</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SecondaryDevice</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The ID of the secondary device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">intercom data</td>
|
||||
<td class="BodyE-Column1-Body1"><i>IntercomData</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Additional data for the intercom event that occurred.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">line number</td>
|
||||
<td class="BodyE-Column1-Body2"><i>LineNumber</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The line number involved in the intercom event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">type</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Type</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Event type i.e., duress, system, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">subtype</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SubType</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Event sub-type i.e., granted, door forced open, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">description</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Description</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">A human readable, brief description of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">serial number</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SerialNumber</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">A number that uniquely identifies the instance of the event for a particular panel.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">server host</td>
|
||||
<td class="BodyE-Column1-Body2"><i>CommServerHostName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Host name of the Communication server through which the event arrived.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">event text</td>
|
||||
<td class="BodyB-Column1-Body1"><i>EventText</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Text associated with event</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="Lenel4"></a>Lenel raw data</h2>
|
||||
<p>Action name:<i>LenelRawData(TimeStamp, LenelData)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Lenel OnGuard raw data.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">data</td>
|
||||
<td class="BodyB-Column1-Body2"><i>LenelData</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">Lenel OnGuard data.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="Lenel5"></a>Lenel refresh names</h2>
|
||||
<p>Action name:<i>LenelRefreshNames()</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Lenel OnGuard refresh names.</p>
|
||||
<h2><a name="Lenel6"></a>Lenel security event</h2>
|
||||
<p>Action name:<i>LenelSecurityEvent(ID, Panel, Device, SecondaryDevice, Type, SubType, Description, SerialNumber, TimeStamp, CommServerHostName, EventText)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Lenel OnGuard security event.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The ID that uniquely identifies the type of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">panel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Panel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The name of the panel where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">device</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Device</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The name of the device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">secondary device</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SecondaryDevice</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The ID of the secondary device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">type</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Type</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Event type i.e., duress, system, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">subtype</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SubType</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Event sub-type i.e., granted, door forced open, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">description</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Description</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">A human readable, brief description of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">serial number</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SerialNumber</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">A number that uniquely identifies the instance of the event for a particular panel.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">server host</td>
|
||||
<td class="BodyE-Column1-Body2"><i>CommServerHostName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Host name of the Communication server through which the event arrived.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">event text</td>
|
||||
<td class="BodyB-Column1-Body1"><i>EventText</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Text associated with event</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="Lenel7"></a>Lenel video event</h2>
|
||||
<p>Action name:<i>LenelVideoEvent(ID, Panel, Device, SecondaryDevice, Channel, Type, SubType, Description, SerialNumber, TimeStamp, StartTime, EndTime, CommServerHostName, EventText)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Lenel OnGuard video event.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr bgcolor="#D9D9D9" class="Body-Body1">
|
||||
<th colspan="2" class="BodyE-Column1-Body1"> </th>
|
||||
<th class="BodyD-Column1-Body1"> </th>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">ID</td>
|
||||
<td class="BodyE-Column1-Body2"><i>ID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The ID that uniquely identifies the type of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">panel</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Panel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The name of the panel where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Device</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The name of the device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">secondary device</td>
|
||||
<td class="BodyE-Column1-Body1"><i>SecondaryDevice</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The ID of the secondary device where this event originated.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Channel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The physical channel the camera is connected to that is creating this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">type</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Type</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Event type i.e., duress, system, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">subtype</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SubType</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Event sub-type i.e., granted, door forced open, etc.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">description</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Description</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">A human readable, brief description of this event.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">serial number</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SerialNumber</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">A number that uniquely identifies the instance of the event for a particular panel.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">start stamp</td>
|
||||
<td class="BodyE-Column1-Body2"><i>StartTime</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">The time the video event started</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">end time</td>
|
||||
<td class="BodyE-Column1-Body1"><i>EndTime</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">The time the video event ended.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">server host</td>
|
||||
<td class="BodyE-Column1-Body2"><i>CommServerHostName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Host name of the Communication server through which the event arrived.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">event text</td>
|
||||
<td class="BodyB-Column1-Body1"><i>EventText</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Text associated with event</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,263 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Logistic</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<style>
|
||||
body
|
||||
{
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Logistic</span>
|
||||
</div>
|
||||
<h1>Logistic</h1>
|
||||
<p>Logistic actions are used in the logistic environment where meta data, e.g. barcodes, is used to start recording events. Later, a research on the barcodes is done to show the scanning operation in the recorded images.
|
||||
To speed up the search, a CRC32 checksum is used as a hash and serves as a foreign key of the event startd. The foreign key is indexed in the event table an can therefore be found much faster than a lookup on the string itself.
|
||||
Additional parameters are used to notify positioning information since the assignment of scanning and recording camera is often done according to the position of the scanner. </p>
|
||||
<h2><a name="Log"></a>Log barcode data</h2>
|
||||
<p>Action name:<i>LogBarcodeData(Barcode, Hash, Scanner, AreaID, AreaName, Channel, TimeStamp)</i></p>
|
||||
<p>Action category: notification</p>
|
||||
<p>Logistic barcode data .</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">barcode</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Barcode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Barcode.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">hash value</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Hash</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Hash value of barcode (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">scanner name</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Scanner</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Scanner name or IP Address (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">area number</td>
|
||||
<td class="BodyE-Column1-Body2"><i>AreaID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Global number of area for event mapping (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">area name</td>
|
||||
<td class="BodyE-Column1-Body1"><i>AreaName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Area name (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Channel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Global number of a media channel for mapping (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">time stamp</td>
|
||||
<td class="BodyB-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Time stamp (Optional)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="Log2"></a>Log barcode data LPS</h2>
|
||||
<p>Action name:<i>LogBarcodeDataLPS(Barcode, Hash, Scanner, AreaID, AreaName, Channel, TimeStamp, X, Y, Z, LpsTagID, LpsStatus, LpsCellID, LpsAreaID, UserParam)</i></p>
|
||||
<p>Action category: notification</p>
|
||||
<p>Logistic barcode data including positioning and area information.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">barcode</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Barcode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Barcode.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">hash value</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Hash</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Hash value of the barcode (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">scanner name</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Scanner</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Scanner name or IP Address (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">area number</td>
|
||||
<td class="BodyE-Column1-Body2"><i>AreaID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Global number of area for event mapping (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">area name</td>
|
||||
<td class="BodyE-Column1-Body1"><i>AreaName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Area name. (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Channel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Global number of a media channel for mapping (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">X coordinate</td>
|
||||
<td class="BodyE-Column1-Body2"><i>X</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">X coordinate of the position query (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Y coordinate</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Y</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Y coordinate of the position query (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">Z coordinate</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Z</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Z coordinate of the position query (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">LPS tag ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>LpsTagID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Tag ID of the positioning system (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">LPS status</td>
|
||||
<td class="BodyE-Column1-Body2"><i>LpsStatus</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">LPS status of the position query(Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">LPS cell ID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>LpsCellID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Cell ID of the positioning system (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">LPS area ID</td>
|
||||
<td class="BodyE-Column1-Body2"><i>LpsAreaID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Area ID of the positioning system (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">User param</td>
|
||||
<td class="BodyB-Column1-Body1"><i>UserParam</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">User param for internal use (Optional)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="Log3"></a>Log NPR recognition</h2>
|
||||
<p>Action name:<i>LogNPRRecognition(PlateNo, Hash, Country, Channel, TimeStamp, Restriction, Category)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Log NPR recognition.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">plate no.</td>
|
||||
<td class="BodyE-Column1-Body1"><i>PlateNo</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Recognized plate no.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">hash value</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Hash</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Hash value of the recognized plate no. (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">country</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Country</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Country (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Channel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Channel (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">time stamp</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Time stamp (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">restriction</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Restriction</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Restriction of recognized number (Optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">category</td>
|
||||
<td class="BodyB-Column1-Body1"><i>Category</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Category of recognized number (Optional)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,533 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>POS</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">POS</span>
|
||||
</div>
|
||||
<h1>POS</h1>
|
||||
<p>Points of sales (POS) Actions enable the exchange of accompanying meta data between POS Management Systems and GeViScope/re_porter. With these actions payment processes can be documented consistently by video. The use of these actions for start and re-start of event recordings leads to the output of accompanying meta data in live video in GSCView as well as in the storage of those in the video data base. The video sequences recorded via POS Actions can easily be retrieved in GscView using the accompanying meta data und special data filter dialogs (optional) Besides the actions POSStatus and POSData for the general integration into POS Management Systems there are also POS actions which belong to special GeViScope drivers. The actions FillingPumpStatus, TerminalArticleData and TerminalPaymentData are used by the driver "HUTH". The driver "HUTH" is a GeViScope Media Plugin, which was developed by GEUTEBRÜCK, to integrate filling station management systems of the manufacturer HUTH Elektronik Systeme GmbH into GeViScope/re_porter. The driver is compatible to HUTH Video Interface T400/T450/Maxi/mini V1.2. The actions InterfaceRawData and InterfaceRawAnswer are also used by the driver "HUTH". But they only serve for debugging and fault analysis purpose. They can also be used in general for any link that the concerned action supports - respectively uses these actions. The action BarcodeData serves as a general integration of barcode scanners.</p>
|
||||
<h2><a name="Barcode"></a>Barcode data</h2>
|
||||
<p>Action name:BarcodeData(ReaderName, TimeStamp, Barcode)
|
||||
|
||||
</p>
|
||||
<p>Action category: notification
|
||||
|
||||
</p>
|
||||
<p>The POS Management System (or any other system like barcode scanner or similar) sends the action as soon as a barcode was read.
|
||||
|
||||
Via the parameter "ReaderName" the affected barcode scanner will be identified.
|
||||
|
||||
The further parameter will be filled with video meta data by the POS Management System.
|
||||
|
||||
</p>
|
||||
<p> </p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 349px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">scanner </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">ReaderName
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of the barcode scanner </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">code </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Barcode </td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical field for recording the scanned barcode. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Filling"></a>Filling pump status</h2>
|
||||
<p>Action name:FillingPumpStatus(TerminalName, TimeStamp, PumpNo, Status, Amount, Price, Details)
|
||||
|
||||
Action category: notification
|
||||
|
||||
</p>
|
||||
<p>The "HUTH" driver sends the action for each status change of one filling pump.
|
||||
|
||||
Via the parameter "TerminalName" the concerned device will be identified. The "HUTH" driver is principally able to build up several connections to different Huth devices. The driver sends the alphanumerical value defined in his setup as "Interface name".
|
||||
|
||||
The further parameter will be filled with video meta data by the driver.
|
||||
|
||||
</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 349px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Terminal </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">TerminalName
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Identifies the affected device. The "HUTH" driver is principally able to build up several connections to different Huth devices. The driver sends the alphanumerical value defined in his setup as "Interface name". </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time Stamp, when the status change was detected by the Huth-System </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">pump no </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">PumpNo </td>
|
||||
<td class="BodyD-Column1-Body1">Number of the filling pump </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">status</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Status</td>
|
||||
<td class="BodyD-Column1-Body2">New status of the filling pump <br />Filling started = Huth-device status "taken off before filling"
|
||||
<br />Filling stopped = Huth-device status "put back on end of filling" <br />Pump released = Huth-device status "disconnect after filling" <br />Amount message = sum - respectively amount notice of the filling pump
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">amount</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Amount</td>
|
||||
<td class="BodyD-Column1-Body1">Amount of the booking (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">price</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Price</td>
|
||||
<td class="BodyD-Column1-Body2">Sum of the booking (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">details</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Details</td>
|
||||
<td class="BodyD-Column1-Body1">Free text (optional)</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Interfac"></a>Interface raw answer</h2>
|
||||
<p>Action name:InterfaceRawAnswer(InterfaceName, TimeStamp, Data)
|
||||
|
||||
</p>
|
||||
<p>Action category: notification
|
||||
|
||||
</p>
|
||||
<p>This action is used by the "HUTH" driver. ". It serves only as a debug service and can also be used in general for any integration that supports or uses this action.
|
||||
|
||||
The "HUTH" driver sends the action for each telegram it has sent to the end device.
|
||||
|
||||
The affected end device will be identified by the parameter "TerminalName". The "HUTH" driver can always build up numerous connections to different Huth devices. The driver then sends the alphanumerical value defined in its setup as "Interface name"
|
||||
|
||||
The further parameter will be filled with video meta data by the driver.
|
||||
|
||||
</p>
|
||||
<p> </p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 350px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">interface </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">InterfaceName </td>
|
||||
<td class="BodyD-Column1-Body1">Identifies the affected end device. The "HUTH" driver is principally able to build up several connections to different Huth devices. The driver sends the alphanumerical value defined in his setup as "Interface name". </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">TimeStamp when the telegram was received from the Huth system. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">answer </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Data </td>
|
||||
<td class="BodyD-Column1-Body1">The sent telegram in raw format. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<h2><a name="Interfac2"></a>Interface raw data
|
||||
</h2>
|
||||
<p>Action name:InterfaceRawData(InterfaceName, TimeStamp, Data)
|
||||
|
||||
</p>
|
||||
<p>Action category: notification
|
||||
|
||||
</p>
|
||||
<p>This action is used by the driver "HUTH". It serves only as a debug service and can also be used in general for any integration that supports or uses this action.
|
||||
|
||||
The "HUTH" driver sends the action for each telegram it has received from the end device.
|
||||
|
||||
The affected end device will be identified by the parameter "TerminalName". The "HUTH" driver can always build up numerous connections to different Huth devices. The driver then sends the alphanumerical value defined in its setup as "Interface name"
|
||||
|
||||
The further parameter will be filled with video meta data by the driver. </p>
|
||||
<p> </p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 350px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">interface </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">InterfaceName </td>
|
||||
<td class="BodyD-Column1-Body1">Identifies the affected end device. The "HUTH" driver is principally able to build up several connections to different Huth devices. The driver sends the alphanumerical value defined in his setup as "Interface name". </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">TimeStamp when the telegram was received from the Huth system. </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">data </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Data </td>
|
||||
<td class="BodyD-Column1-Body1">The received telegram in raw format. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="POS"></a>POS data</h2>
|
||||
<p>Action name:POSData(POSName, TimeStamp, Article, Price, Units, PricePerUnit, Line1, Line2, Line3, Line4, Line5)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>The POS Management System sends the action for each transaction carried out at a cash point</p>
|
||||
<p>Via the parameter "POS"the affected cash point will be identified. The further parameter will be filled with video meta data by the POS Management System</p>
|
||||
<p> </p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 350px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">POS
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">POSName
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of the cash point </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time Stamp, when the action was send from the POS management system </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">article
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Article
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Identification of the booked article (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">price
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Price
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Amount (single price multiplied with number of articles) of transaction (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">units
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Units
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Amount of articles of the transaction (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">price per unit
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">PricePerUnit
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Single article price of the transaction (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">line 1
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Line1
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical fields /sections for storing of additional information concerning the transaction or for storing information which have been printed out on the sales slip (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">line 2
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Line2
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Alphanumerical fields /sections for storing of additional information concerning the transaction or for storing information which have been printed out on the sales slip (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">line 3
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Line3
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical fields /sections for storing of additional information concerning the transaction or for storing information which have been printed out on the sales slip (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">line 4
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Line4
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Alphanumerical fields /sections for storing of additional information concerning the transaction or for storing information which have been printed out on the sales slip (optional) </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">line 5
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Line5
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical fields /sections for storing of additional information concerning the transaction or for storing information which have been printed out on the sales slip (optional) </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="POS2"></a>POS status</h2>
|
||||
<p>Action name:POSStatus(POSName, TimeStamp, Status, Details)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p>The POS management system sends the action as soon as the cash point is opened or closed or as soon as a cancellation will be made at a cash point.</p>
|
||||
<p>Via the parameter "POS" the concerned cash point will be identified. The further parameter will be filled with video meta data from the POS management system.</p>
|
||||
<p>The parameter "Status" can be addressed by the POS management system with a code figure for the currently notified status.</p>
|
||||
<p> </p>
|
||||
<table style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 350px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">POS
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">POSName
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Alphanumerical identification of cash point </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time Stamp, when the action was sent from the POS management system</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">status
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Status
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Identification figure for the currently notified status </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">details
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Details
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Additional alphanumerical information from POS management system (optional) </td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Terminal"></a>Terminal article data</h2>
|
||||
<p>Action name:TerminalArticleData(TerminalName, TimeStamp, CashierStation, PumpNo, AlarmStatus, Amount, Price, Details)
|
||||
|
||||
</p>
|
||||
<p>Action category: notification
|
||||
</p>
|
||||
<p>The "Huth" driver sends the actions for each product-group-booking.
|
||||
|
||||
Via the parameter "TerminalName" the affected device will be identified. The "HUTH" driver is principally able to build up several connections to different Huth devices . The driver sends the alphanumerical value defined in his setup as "Interface name".
|
||||
|
||||
The further parameter will be filled with video meta data via the driver.
|
||||
|
||||
</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 349px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Terminal </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">TerminalName
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Identifies the affected device. The "HUTH" driver is principally able to build up several connections to different Huth devices. The driver sends the alphanumerical value defined in his setup as "Interface name". </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time Stamp, when the status change was detected by the Huth-System </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">cashier station</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">CashierStation</td>
|
||||
<td class="BodyD-Column1-Body1">Number of the cash point where the booking is carried out</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">pump no</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">PumpNo</td>
|
||||
<td class="BodyD-Column1-Body2">Number of the filling point</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">alarm</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">AlarmStatus</td>
|
||||
<td class="BodyD-Column1-Body1">Status of Alarm-Flags
|
||||
<br />Yes = Alarm-Flag was set by the Huth system
|
||||
<br />No = Alarm-Flag not set
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">amount</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Amount</td>
|
||||
<td class="BodyD-Column1-Body2">Amount of the booking (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">price</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Price</td>
|
||||
<td class="BodyD-Column1-Body1">Sum of the booking (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">details</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Details</td>
|
||||
<td class="BodyD-Column1-Body2">Free text (optional)</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Terminal2"></a>Terminal payment data</h2>
|
||||
<p>Action name:TerminalPaymentData(TerminalName, TimeStamp, CashierStation, PumpNo, AlarmStatus, Amount, Price, Details)
|
||||
|
||||
</p>
|
||||
<p>Action category: notification
|
||||
|
||||
</p>
|
||||
<p>The "HUTH" driver sends the action for each termination of a booking with the used method of payment.
|
||||
|
||||
Via the parameter "TerminalName" the affected device will be identified. The "HUTH" driver is principally able to build up several connections to different Huth devices. The driver sends the alphanumerical value defined in his setup as "Interface name".
|
||||
|
||||
The further parameter will be filled with video meta data via the driver.
|
||||
|
||||
</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 349px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter
|
||||
</th>
|
||||
<th class="HeadD-Column1-Header1">Function
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">Terminal </td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">TerminalName
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Identifies the affected device. The "HUTH" driver is principally able to build up several connections to different Huth devices. The driver sends the alphanumerical value defined in his setup as "Interface name". </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp
|
||||
</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">TimeStamp
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Time Stamp, when the status change was detected by the Huth-System </td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">cashier station</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">CashierStation</td>
|
||||
<td class="BodyD-Column1-Body1">Number of the cash point where the booking is carried out with the used payment method</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">pump no</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">PumpNo</td>
|
||||
<td class="BodyD-Column1-Body2">Number of the filling point (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">alarm</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">AlarmStatus</td>
|
||||
<td class="BodyD-Column1-Body1">Status of Alarm-Flags
|
||||
<br />Yes = Alarm-Flag was set by the Huth system
|
||||
<br />No = Alarm-Flag not set
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">amount</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Amount</td>
|
||||
<td class="BodyD-Column1-Body2">Amount of the booking (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">price</td>
|
||||
<td class="BodyE-Column1-Body1" style="font-style: italic;">Price</td>
|
||||
<td class="BodyD-Column1-Body1">Sum of the booking (optional)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">details</td>
|
||||
<td class="BodyE-Column1-Body2" style="font-style: italic;">Details</td>
|
||||
<td class="BodyD-Column1-Body2">Free text (optional)</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,172 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>POS</title>
|
||||
<link href="../Resources/TableStyles/Rows.css" rel="stylesheet" />
|
||||
<style>
|
||||
body
|
||||
{
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>POS</h1>
|
||||
<p>POS (point of sale).</p>
|
||||
<h2>Barcode data</h2>
|
||||
<p>Action name:<i>BarcodeData(ReaderName, TimeStamp, Barcode)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Barcode data.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">scanner</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ReaderName</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Scanner name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">time stamp</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Time stamp.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">code</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Barcode</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Barcode.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>POS data</h2>
|
||||
<p>Action name:<i>POSData(POSName, TimeStamp, Article, Price, Units, PricePerUnit, Line1, Line2, Line3, Line4, Line5)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>POS data.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">POS</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>POSName</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">POS name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">time stamp</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Time stamp.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">article</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Article</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Article description.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">price</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Price</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Price.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">units</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Units</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Number of units.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">price per unit</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>PricePerUnit</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Price per unit.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">line 1</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Line1</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Line 1.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">line 2</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Line2</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Line 2.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">line 3</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Line3</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Line 3.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">line 4</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Line4</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Line 4.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">line 5</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Line5</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Line 5.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>POS status</h2>
|
||||
<p>Action name:<i>POSStatus(POSName, TimeStamp, Status, Details)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>POS status.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">POS</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>POSName</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">POS name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">time stamp</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Time stamp.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">status</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Status</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Status.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">details</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Details</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Details.</td>
|
||||
</tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,350 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Remote export</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<style>/*<![CDATA[*/BODY {
|
||||
FONT-FAMILY: Arial, Helvetica, sans-serif; FONT-SIZE: 10pt
|
||||
}
|
||||
/*]]>*/</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Remote export</span>
|
||||
</div>
|
||||
<h1>Remote export</h1>
|
||||
<p>The actions of the category "Remote Export" subserve to start and control
|
||||
exports over the network. The actions are only at disposal if GSCRemEx service
|
||||
runs on every device and a connection to a central GeViSoft server persists. The
|
||||
GSCServer and GSCRemEx service have to run together on a local machine otherwise
|
||||
exports are not possible. The GSCRemEx service has to be setup in advance by
|
||||
GSCRemExEditor. The exports can be executed by a PILOT center device or other
|
||||
software systems (SDK based, GEUTEBRUECK devices). The PILOT is a system
|
||||
management console of GEUTEBRUECK which simplifies the handling of complex
|
||||
security systems. The PILOT among others can be used to control GSCView.
|
||||
Especially in view of the fact of exports the user can define start and end
|
||||
points by the help of the PILOT through GSCRemEx ("SetExportMarker" action).
|
||||
GSCView remembers the points in time and inserts them to the action
|
||||
"StartRemoteExport". The action "StartRemoteExport" is initiated by GSCView
|
||||
after the PILOT has send the action "InitializeRemoteExport" by indirection via
|
||||
the GeViSoft server and GeViScope server to GSCView. GSCView sends the action
|
||||
"StartRemoteExport" to the GSCRemEx service and triggers the appropriate export.
|
||||
Exports that have been started through GSCRemEx service can be started or
|
||||
aborted from other devices or software systems over the network. Exports that
|
||||
have been started locally in GSCView cannot be controlled from other devices or
|
||||
software systems. In the curse of an export process no new export can be
|
||||
started. This export has to be restarted after the running export process has
|
||||
been completed! The actions "SetExportMarker" and "InitializeRemoteExport" have
|
||||
been developed especially for the PILOT. </p>
|
||||
<h2>Cancel export</h2>
|
||||
<p>Action name:<i>CancelExport(ExportID, AbortFlag)</i></p>
|
||||
<p>Action category: command</p>
|
||||
<p>Through this action the running export process with the specified export ID
|
||||
is being aborted if GSCView remote-controls the GSCRemEx service. If the
|
||||
GSCRemEx service is remote-controlled by an external application the external
|
||||
application has to send the action to abort the running export process.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 380px;" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">export GUID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ExportID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">ID of the export process that has to be aborted. <br />The export GUID
|
||||
is being assigned on the action "StartRemoteExport". <br />e.g.:
|
||||
01E68451-2406-484d-A9BC-5140762931E0 <br /></td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">abort flag</td>
|
||||
<td class="BodyB-Column1-Body2"><i>AbortFlag</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">reason for abort <br />0: user abort; abort of export through user
|
||||
<br />1: low disc space; too little storage capacity <br />2: no user rights;
|
||||
access based on restricted user rights not possible <br />3: error; internal
|
||||
error <br /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Export finished</h2>
|
||||
<p>Action name:<i>ExportFinished(ExportID, Success)</i></p>
|
||||
<p>Action category: notification</p>
|
||||
<p>The GSCRemEx service notifies through this action that the running process
|
||||
was completed. </p>
|
||||
<p>Possible status messages are: user abort, low disc space, no user rights,
|
||||
error. </p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 380px;" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">export GUID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ExportID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">ID of completed export process. The export GUID is being assigned on
|
||||
the action "StartRemoteExport". <br />e.g.:
|
||||
01E68451-2406-484d-A9BC-5140762931E0 <br /></td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">success</td>
|
||||
<td class="BodyB-Column1-Body2"><i>Success</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">reason for abort <br />0: user abort; abort of export through user
|
||||
<br />1: low disc space; too little storage capacity <br />2: no user rights;
|
||||
access based on restricted user rights not possible <br />3: error; internal
|
||||
error <br /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Export progress</h2>
|
||||
<p>Action name:<i>ExportProgress(ExportID, Progress)</i></p>
|
||||
<p>Action category: notification</p>
|
||||
<p>The GSCRemEx service notifies the current status of the running export
|
||||
process in %.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 380px;" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">export GUID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ExportID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">ID of running export. The export GUID is being assigned on the action
|
||||
"StartRemoteExport". <br />e.g.: 01E68451-2406-484d-A9BC-5140762931E0
|
||||
<br /></td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">progress</td>
|
||||
<td class="BodyB-Column1-Body2"><i>Progress</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">shows current status of the export process in %</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Initialize remote export</h2>
|
||||
<p>Action name:<i>InitializeRemoteExport(Viewer, Device)</i></p>
|
||||
<p>Action category: command</p>
|
||||
<p>This action is being used especially in the context of control units or
|
||||
systems like for example the PILOT. </p>
|
||||
<p>The PILOT center device notifies GSCView that a new export has to be
|
||||
initiated. Thereupon GSCView creates the action "StartRemoteExport" with the
|
||||
appropriate parameters. </p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 79px;" />
|
||||
<col class="Column-Column1" style="width: 380px;" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Viewer</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">global viewer number <br /></td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">device GUID</td>
|
||||
<td class="BodyB-Column1-Body2"><i>Device</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">ID of the PILOT center device (transmitted by the PILOT itself)
|
||||
<br />e.g.: 01E68451-2406-484d-A9BC-5140762931E0 <br /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Set export marker</h2>
|
||||
<p>Action name:<i>SetExportMarker(Viewer, Marker)</i></p>
|
||||
<p>Action category: command</p>
|
||||
<p>This action is being used especially in the context of control units or
|
||||
systems like for example the PILOT. </p>
|
||||
<p>It indicates GSCView that an export start and end point has to be set on the
|
||||
current position of viewer X. </p>
|
||||
<p>The so-called markers are being transferred automatically into the
|
||||
"StartRemoteExport" action once the "InitializeRemoteExport" action has been
|
||||
sent from the PILOT. The action "StartRemoteExport" transfers the start and end
|
||||
points to the GSCRemEx service which conducts the appropriate export. </p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 380px;" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1"><i>Viewer</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">global viewer number <br /></td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">marker</td>
|
||||
<td class="BodyB-Column1-Body2"><i>Marker</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">tags and stores the start and end point of the data that has to be
|
||||
exported <br />(selection begin=0, selection end=1) <br /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Start remote export</h2>
|
||||
<p>Action name:<i>StartRemoteExport(ExportID, Device, BackupFormat, Channel,
|
||||
SelectionBegin, SelectionEnd, JobID)</i></p>
|
||||
<p>Action category: command</p>
|
||||
<p>This action tells the GSCRemEx service to start a new export. </p>
|
||||
<p>The action "StartRemoteExport" was created because the PILOT or another
|
||||
external software system did send the action "InitializeRemoteExport" to GSCView
|
||||
before. </p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" style="width: 80px;" />
|
||||
<col class="Column-Column1" style="width: 90px;" />
|
||||
<col class="Column-Column1" style="width: 371px;" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">export GUID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>ExportID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">ID of running exports. The export GUID has to be determined separately
|
||||
in advance because the action itself does not create a GUID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device GUID</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Device</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">ID of PILOT center device. If no PILOT is being used the blank GUID
|
||||
can be used instead. <br />e.g.: 01E68451-2406-484d-A9BC-5140762931E0
|
||||
<br /></td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">format</td>
|
||||
<td class="BodyE-Column1-Body1"><i>BackupFormat</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">defines the format of the exported file <br />0=default (in this case it
|
||||
equals 1=GBF) <br />1=GBF( GEUTEBRUECK backup file) <br />2=MPEG2 <br /></td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2"><i>Channel</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">global channel number/camera number</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">start time</td>
|
||||
<td class="BodyE-Column1-Body1"><i>SelectionBegin</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">holds the position of the marker for the start point ("selection
|
||||
begin")</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">end time</td>
|
||||
<td class="BodyE-Column1-Body2"><i>SelectionEnd</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">holds the position of the marker for the end point ("selection
|
||||
end")</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">job ID</td>
|
||||
<td class="BodyB-Column1-Body1"><i>JobID</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Contains the login data (server name, user name, encoded password)
|
||||
<br />Optional second user password. The login data is separated by |.
|
||||
<br />e.g.: <server
|
||||
name>|<user>|<PW>|<user2>|<PW2>
|
||||
<br />localhost|admin|test| <br />If there is no second user (second user
|
||||
password) nothing has to be <br />entered at this point. <br />Passwords in
|
||||
this parameter are encoded. Therefor the function <br />DBIEncodeString() of
|
||||
GscDBI-DLL (from GeViScope/re_porter SDK) is being used.
|
||||
<br /></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Start scene store</h2>
|
||||
<p>Action name:<i>StartSceneStore(SceneStoreID, CutList, PreHistoryLength,
|
||||
RecordingLength)</i></p>
|
||||
<p>Action category: command</p>
|
||||
<p>For internal use only!</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" style="width: 315px;" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">scene store GUID</td>
|
||||
<td class="BodyE-Column1-Body1"><i>SceneStoreID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Scene store GUID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">cut-list</td>
|
||||
<td class="BodyE-Column1-Body2"><i>CutList</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Cut-list.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">pre-history length</td>
|
||||
<td class="BodyE-Column1-Body1"><i>PreHistoryLength</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Pre-history length.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">recording length</td>
|
||||
<td class="BodyB-Column1-Body2"><i>RecordingLength</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">Recording length.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,243 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>SKIDATA</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<style>
|
||||
body
|
||||
{
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">SKIDATA</span>
|
||||
</div>
|
||||
<h1>SKIDATA</h1>
|
||||
<p>SKIDATA messages.</p>
|
||||
<h2><a name="SKIDATA"></a>SKIDATA control</h2>
|
||||
<p>Action name:<i>SkidataControl(InterfaceName, Data)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>SKIDATA control information.</p>
|
||||
<table border="1" style="caption-side: top;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">interface</td>
|
||||
<td class="BodyE-Column1-Body1"><i>InterfaceName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Interface name.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyB-Column1-Body2">state</td>
|
||||
<td class="BodyB-Column1-Body2"><i>Data</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body2">Interface state.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p> </p>
|
||||
<h2><a name="SKIDATA5"></a>SKIDATA device event</h2>
|
||||
<p>Action name:SkidataDeviceEvent(InterfaceName, DeviceID, EventCode)</p>
|
||||
<p>Action category: logical</p>
|
||||
<p> </p>
|
||||
<p>SKIDATA device event.</p>
|
||||
<table border="1" style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">interface</td>
|
||||
<td class="BodyE-Column1-Body1"><i>InterfaceName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Interface name.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">device</td>
|
||||
<td class="BodyE-Column1-Body2"><i>DeviceID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Device ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">event code</td>
|
||||
<td class="BodyB-Column1-Body1"><i>EventCode</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Event code.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="SKIDATA2"></a>SKIDATA entry</h2>
|
||||
<p>Action name:<i>SkidataEntry(InterfaceName, MessageCode, TranscactionID, CarParkNo, DeviceID)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>SKIDATA entry.</p>
|
||||
<table border="1" style="margin-left: 0;margin-right: auto;caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">interface</td>
|
||||
<td class="BodyE-Column1-Body1"><i>InterfaceName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Interface name.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">message</td>
|
||||
<td class="BodyE-Column1-Body2"><i>MessageCode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Message code.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">transaction</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TranscactionID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Transcaction ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">car park</td>
|
||||
<td class="BodyE-Column1-Body2"><i>CarParkNo</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Car park no.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">device</td>
|
||||
<td class="BodyB-Column1-Body1"><i>DeviceID</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Device ID.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="SKIDATA3"></a>SKIDATA exit</h2>
|
||||
<p>Action name:<i>SkidataExit(InterfaceName, MessageCode, TranscactionID, CarParkNo, DeviceID)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>SKIDATA exit.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">interface</td>
|
||||
<td class="BodyE-Column1-Body1"><i>InterfaceName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Interface name.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">message</td>
|
||||
<td class="BodyE-Column1-Body2"><i>MessageCode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Message code.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">transaction</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TranscactionID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Transcaction ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">car park</td>
|
||||
<td class="BodyE-Column1-Body2"><i>CarParkNo</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Car park no.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">device</td>
|
||||
<td class="BodyB-Column1-Body1"><i>DeviceID</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Device ID.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a name="SKIDATA4"></a>SKIDATA transaction</h2>
|
||||
<p>Action name:<i>SkidataTransaction(InterfaceName, MessageCode, TranscactionID, CarParkNo, DeviceID)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>SKIDATA transaction.</p>
|
||||
<table border="1" style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');" class="TableStyle-Rows" cellspacing="0">
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">interface</td>
|
||||
<td class="BodyE-Column1-Body1"><i>InterfaceName</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Interface name.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">message</td>
|
||||
<td class="BodyE-Column1-Body2"><i>MessageCode</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Message code.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">transaction</td>
|
||||
<td class="BodyE-Column1-Body1"><i>TranscactionID</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body1">Transcaction ID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">car park</td>
|
||||
<td class="BodyE-Column1-Body2"><i>CarParkNo</i>
|
||||
</td>
|
||||
<td class="BodyD-Column1-Body2">Car park no.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyB-Column1-Body1">device</td>
|
||||
<td class="BodyB-Column1-Body1"><i>DeviceID</i>
|
||||
</td>
|
||||
<td class="BodyA-Column1-Body1">Device ID.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,304 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Viewer notifications</title>
|
||||
<link href="../Resources/TableStyles/Rows.css" rel="stylesheet" />
|
||||
<style>
|
||||
body
|
||||
{
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
font-size: 10pt;
|
||||
}
|
||||
|
||||
</style>
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Viewer notifications</h1>
|
||||
<p>All viewer notifictions.</p>
|
||||
<h2>Image export notification</h2>
|
||||
<p>Action name:<i>ImageExportNotification(User, Destination, DestinationType, TimeStamp, TimeEnd, Channels, ClientHost, ClientType, ClientAccount)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Notification on export or print of channel images.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">user</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>User</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Name of the user connected to the system.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">destination</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Destination</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Destination.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">destination type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>DestinationType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Destination type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">time stamp</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>TimeStamp</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Time stamp.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">end time</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>TimeEnd</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">End time.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">channels</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Channels</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Channels.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client host</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientHost</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Host from where the connection is done.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">client type</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ClientType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Client type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client account</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientAccount</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">User account from where the connection is done.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>VC alarm queue notification</h2>
|
||||
<p>Action name:<i>VCAlarmQueueNotification(Viewer, Notification, AlarmID, TypeID, ClientHost, ClientType, ClientAccount)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Alarm queue notification on the viewer client.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">viewer</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Viewer</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Global viewer or viewer client no.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">notification</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Notification</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Alarm state notification.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">instance ID</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>AlarmID</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Instance ID of the alarm.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">event type</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>TypeID</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Type of the event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client host</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientHost</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Host from where the connection is done.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">client type</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ClientType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Client type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client account</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientAccount</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">User account from where the connection is done.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>VC scene changed</h2>
|
||||
<p>Action name:<i>VCSceneChanged(Viewer, Scene)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Viewer client scene changed.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">viewer</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Viewer</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Global viewer or viewer client no.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">scene</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Scene</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Scene name.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Viewer cleared</h2>
|
||||
<p>Action name:<i>ViewerCleared(Viewer, ClientHost, ClientType, ClientAccount)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Viewer cleared.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">viewer</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Viewer</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Global viewer or viewer client no.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">client host</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ClientHost</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Host from where the connection is done.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Client type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">client account</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ClientAccount</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">User account from where the connection is done.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Viewer connected</h2>
|
||||
<p>Action name:<i>ViewerConnected(Viewer, Channel, PlayMode, ClientHost, ClientType, ClientAccount)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Viewer connected to the camera.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">viewer</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Viewer</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Global viewer or viewer client no.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">channel</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Channel</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">play mode</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>PlayMode</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Viewer play mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">client host</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ClientHost</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Host from where the connection is done.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client type</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Client type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">client account</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ClientAccount</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">User account from where the connection is done.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Viewer play mode changed</h2>
|
||||
<p>Action name:<i>ViewerPlayModeChanged(Viewer, Channel, PlayMode, ChannelTime, ClientHost, ClientType, ClientAccount)</i></p>
|
||||
<p>Action category: logical</p>
|
||||
<p>Viewer play mode changed.</p>
|
||||
<table border="1" style="mc-table-style: url('../Resources/TableStyles/Rows.css');" class="TableStyle_Rows" cellspacing="0">
|
||||
<tr bgcolor="#D9D9D9">
|
||||
<th colspan="2" class="TableStyle_Rows_Body_0_0_RowSep_ColSep" style="font-weight: bold;">Parameter</th>
|
||||
<th class="TableStyle_Rows_Body_0_0_RowSep_ColEnd" style="font-weight: bold;">Function</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">viewer</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>Viewer</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Global viewer or viewer client no.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">channel</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>Channel</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Channel.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">play mode</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>PlayMode</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Viewer play mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">channel time</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ChannelTime</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Channel time.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client host</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientHost</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">Host from where the connection is done.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep">client type</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColSep"><i>ClientType</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_0_0_RowSep_ColEnd">Client type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep">client account</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColSep"><i>ClientAccount</i>
|
||||
</td>
|
||||
<td class="TableStyle_Rows_Body_1_0_RowSep_ColEnd">User account from where the connection is done.</td>
|
||||
</tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,455 @@
|
||||
<!DOCTYPE html>
|
||||
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" lang="en" xml:lang="en" data-mc-search-type="Stem" data-mc-help-system-file-name="index.xml" data-mc-path-to-help-system="../../" data-mc-target-type="WebHelp2" data-mc-runtime-file-type="Topic" data-mc-preload-images="false" data-mc-in-preview-mode="false" data-mc-toc-path="GeViScope SDK|Action documentation">
|
||||
<!-- saved from url=(0014)about:internet -->
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Viewer notifications</title>
|
||||
<link href="../Resources/TableStyles/TABLE.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/TextEffects.css" rel="stylesheet" />
|
||||
<link href="../../Skins/Default/Stylesheets/Topic.css" rel="stylesheet" />
|
||||
<link href="../Resources/Stylesheets/Styles.css" rel="stylesheet" />
|
||||
<script src="../../Resources/Scripts/jquery.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/plugins.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.min.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/require.config.js">
|
||||
</script>
|
||||
<script src="../../Resources/Scripts/MadCapAll.js">
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="MCBreadcrumbsBox_0"><span class="MCBreadcrumbsPrefix">| </span><a class="MCBreadcrumbsLink" href="../Titel.htm">GeViScope SDK</a><span class="MCBreadcrumbsDivider"> > </span><a class="MCBreadcrumbsLink" href="../300_Action documentation.htm">Action documentation</a><span class="MCBreadcrumbsDivider"> > </span><span class="MCBreadcrumbs">Viewer notifications</span>
|
||||
</div>
|
||||
<h1>Viewer notification actions</h1>
|
||||
<p>Viewer notifications are fired by GSCView while GSCView is remote controlled. To enable remote controlling GSCView the "Remote control" setting in GscProfileManager and a global unique viewer client number has to be configured. To enable GSCView sending viewer notifications the "Send notification actions" settings in GscProfileManager have to be configured.</p>
|
||||
<p> </p>
|
||||
<h2><a name="Image"></a>Image export notification</h2>
|
||||
<p>Action name:ImageExportNotification(User, Destination, DestinationType, TimeStamp, TimeEnd, Channels, ClientHost, ClientType, ClientAccount)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p>A single image or a video sequence has been exported by a GSCView in the network.</p>
|
||||
<p> </p>
|
||||
<p>GSCView has fired this notification because a single picture has been exported via a ViewerExportPicture action while GSCView is remote controlled or because the user has manually exported a picture or a video sequence in GSCView.</p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">user</td>
|
||||
<td class="BodyE-Column1-Body1">User</td>
|
||||
<td class="BodyD-Column1-Body1">GeViScope user, who has done the export</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">destination</td>
|
||||
<td class="BodyE-Column1-Body2">Destination</td>
|
||||
<td class="BodyD-Column1-Body2">Path (local or UNC) where the picture or sequence was exported</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">destination type</td>
|
||||
<td class="BodyE-Column1-Body1">DestinationType</td>
|
||||
<td class="BodyD-Column1-Body1">0 = single image <br />1 = backup file (GBF) <br />2 = video file (MPEG, Video DVD, MPEG4CCTV raw) <br />3 = snapshot to clipboard <br />4 = print picture
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp</td>
|
||||
<td class="BodyE-Column1-Body2">TimeStamp</td>
|
||||
<td class="BodyD-Column1-Body2">Timestamp belonging to the picture exported or belonging to the first picture of the exported video sequence. The parameter is transmitted in the following format:
|
||||
"2009/05/06 14:47:48,359 GMT+02:00"
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">end time</td>
|
||||
<td class="BodyE-Column1-Body1">TimeEnd</td>
|
||||
<td class="BodyD-Column1-Body1">Timestamp belonging to the last picture of the exported video sequence. The parameter is transmitted in the following format:
|
||||
"2009/05/06 14:47:48,359 GMT+02:00"
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channels</td>
|
||||
<td class="BodyE-Column1-Body2">Channels</td>
|
||||
<td class="BodyD-Column1-Body2">List of video channels that are included in the export result</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client host</td>
|
||||
<td class="BodyE-Column1-Body1">ClientHost</td>
|
||||
<td class="BodyD-Column1-Body1">Host name of the PC where GSCView is running</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client type</td>
|
||||
<td class="BodyE-Column1-Body2">ClientType</td>
|
||||
<td class="BodyD-Column1-Body2">1 = GSCView <br />All other values are for future use!
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client account</td>
|
||||
<td class="BodyE-Column1-Body1">ClientAccount</td>
|
||||
<td class="BodyD-Column1-Body1">Windows user account under that GSCView is running</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Scene"></a>Scene store modification</h2>
|
||||
<p>Action name:SceneStoreModification(Viewer, SceneStoreID, SceneStoreName, TimeStamp, ModificationType, User, ClientHost, ClientType, ClientAccount)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p> </p>
|
||||
<p>Scene store modification.</p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 358px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1">Viewer</td>
|
||||
<td class="BodyD-Column1-Body1">Global number of a viewer on some GSCView in the network</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">scene store GUID</td>
|
||||
<td class="BodyE-Column1-Body2">SceneStoreID</td>
|
||||
<td class="BodyD-Column1-Body2">Scene store GUID.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">scene store name</td>
|
||||
<td class="BodyE-Column1-Body1">SceneStoreName</td>
|
||||
<td class="BodyD-Column1-Body1">Scene store name.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">time stamp</td>
|
||||
<td class="BodyE-Column1-Body2">TimeStamp</td>
|
||||
<td class="BodyD-Column1-Body2">Time stamp.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">modification type</td>
|
||||
<td class="BodyE-Column1-Body1">ModificationType</td>
|
||||
<td class="BodyD-Column1-Body1">Modification type.
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">user</td>
|
||||
<td class="BodyE-Column1-Body2">User</td>
|
||||
<td class="BodyD-Column1-Body2">Name of the user.</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client host</td>
|
||||
<td class="BodyE-Column1-Body1">ClientHost</td>
|
||||
<td class="BodyD-Column1-Body1">Host name of the PC where GSCView is running</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client type</td>
|
||||
<td class="BodyE-Column1-Body2">ClientType</td>
|
||||
<td class="BodyD-Column1-Body2">1 = GSCView <br />All other values are for future use!
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client account</td>
|
||||
<td class="BodyE-Column1-Body1">ClientAccount</td>
|
||||
<td class="BodyD-Column1-Body1">Windows user account under that GSCView is running</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="VC"></a>VC alarm queue notification</h2>
|
||||
<p>Action name:VCAlarmQueueNotification(Viewer, Notification, AlarmID, TypeID, ClientHost, ClientType, ClientAccount)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p>The state of the alarm queue of the GSCView with the transmitted viewer client number has been changed.</p>
|
||||
<p> </p>
|
||||
<p>GSCView has fired this notification because the state of its alarm queue has been changed via a VCAlarmQueue... action while GSCView is remote controlled or because the user has manually changed the state of the alarm queue in GSCView.</p>
|
||||
<p> </p>
|
||||
<p>An alarm can be identified by its alarm instance ID (event instance ID). Every alarm (event) is assigned a unique instance ID at creation time by the GeViScope server.</p>
|
||||
<p> </p>
|
||||
<p>Alternatively the alarm can be identified by its alarm type (event type) which means the name of the alarm (event) in the GeViScope Setup event list.</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1">Viewer</td>
|
||||
<td class="BodyD-Column1-Body1">Global viewer client number, identifies the GSCView that fired this notification</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">notification</td>
|
||||
<td class="BodyE-Column1-Body2">Notification</td>
|
||||
<td class="BodyD-Column1-Body2">New alarm = an new alarm occurred
|
||||
<br />Presented = an alarm was presented <br />Stacked = an alarm was stacked in the queue, because the queue is blocked by an active alarm
|
||||
<br />Confirmed = an alarm was confirmed <br />Removed = an alarm was removed from the queue <br />Last confirmed = the last alarm in the queue was confirmed <br />Last removed = the last alarm was removed from the queue <br />List confirmed = there are no more unconfirmed alarms in the queue <br />List empty = there are no more alarms in the queue
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">instance ID</td>
|
||||
<td class="BodyE-Column1-Body1">AlarmID</td>
|
||||
<td class="BodyD-Column1-Body1">The alarm instance ID (event instance ID)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">event type</td>
|
||||
<td class="BodyE-Column1-Body2">TypeID</td>
|
||||
<td class="BodyD-Column1-Body2">The alarm type (event type)</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client host</td>
|
||||
<td class="BodyE-Column1-Body1">ClientHost</td>
|
||||
<td class="BodyD-Column1-Body1">Host name of the PC where GSCView is running</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client type</td>
|
||||
<td class="BodyE-Column1-Body2">ClientType</td>
|
||||
<td class="BodyD-Column1-Body2">1 = GSCView <br />All other values are for future use!
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client account</td>
|
||||
<td class="BodyE-Column1-Body1">ClientAccount</td>
|
||||
<td class="BodyD-Column1-Body1">Windows user account under that GSCView is running</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="VC2"></a>VC scene changed</h2>
|
||||
<p>Action name:VCSceneChanged(Viewer, Scene)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p>The active scene of the GSCView with the transmitted viewer client number has been changed.</p>
|
||||
<p> </p>
|
||||
<p>GSCView has fired this notification because its active scene has been changed via a VCChangeSceneByName or ViewerChangeScene action while GSCView is remote controlled or because the user has manually changed the active scene in GSCView.</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 357px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1">Viewer</td>
|
||||
<td class="BodyD-Column1-Body1">Global viewer client number, identifies the GSCView that fired this notification</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">scene</td>
|
||||
<td class="BodyE-Column1-Body2">Scene</td>
|
||||
<td class="BodyD-Column1-Body2">The name of the scene that is displayed after the change</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Viewer"></a>Viewer cleared</h2>
|
||||
<p>Action name:ViewerCleared(Viewer, ClientHost, ClientType, ClientAccount)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p>The viewer with the transmitted global number on some GSCView in the network has been cleared.</p>
|
||||
<p> </p>
|
||||
<p>GSCView has fired this notification because one of its viewers has been cleared via a ViewerClear action while GSCView is remote controlled or because the user has manually cleared the viewer in GSCView.</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 355px;" class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1">Viewer</td>
|
||||
<td class="BodyD-Column1-Body1">Global number of a viewer on some GSCView in the network</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client host</td>
|
||||
<td class="BodyE-Column1-Body2">ClientHost</td>
|
||||
<td class="BodyD-Column1-Body2">Host name of the PC where GSCView is running</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client type</td>
|
||||
<td class="BodyE-Column1-Body1">ClientType</td>
|
||||
<td class="BodyD-Column1-Body1">1 = GSCView
|
||||
<br />All other values are for future use!
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client account</td>
|
||||
<td class="BodyE-Column1-Body2">ClientAccount</td>
|
||||
<td class="BodyD-Column1-Body2">Windows user account under that GSCView is running</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Viewer2"></a>Viewer connected</h2>
|
||||
<p>Action name:ViewerConnected(Viewer, Channel, PlayMode, ClientHost, ClientType, ClientAccount)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p>The viewer with the transmitted global number on some GSCView in the network has been connected.</p>
|
||||
<p> </p>
|
||||
<p>GSCView has fired this notification because one of its viewers has been connected via a ViewerConnect or ViewerConnectLive action while GSCView is remote controlled or because the user has manually connected the viewer in GSCView.</p>
|
||||
<p> </p>
|
||||
<p>The parameter "play mode" defines in which mode the pictures are presented (live, forward, backward, .).</p>
|
||||
<p> </p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1">Viewer</td>
|
||||
<td class="BodyD-Column1-Body1">Global number of a viewer on some GSCView in the network</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2">Channel</td>
|
||||
<td class="BodyD-Column1-Body2">Global number of the media channel</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">play mode</td>
|
||||
<td class="BodyE-Column1-Body1">PlayMode</td>
|
||||
<td class="BodyD-Column1-Body1">play stop = if the viewer is already displaying pictures from that channel, it is stopped; if not the newest picture in the database is displayed<br />play forward = if the viewer is already displaying pictures from that channel, it is displaying pictures in normal speed forward from the actual position; if not display of pictures with normal speed starts at the beginning of the database<br />play backward = if the viewer is already displaying pictures from that channel, it is displaying pictures in normal speed backward from the actual position; if not display of pictures with normal speed starts at the end of the database<br />fast forward = like "play forward" but with high speed<br />fast backward = like "play backward" but with high speed<br />step forward = like "play forward" but only one picture<br />step backward = like "play backward" but only one picture<br />play BOD = display the first (the oldest) picture in the database<br />play EOD = display the last (the newest) picture in the database<br />live = display live pictures<br />next event = like "play forward" but only pictures that belong to event recordings<br />prev event = like "play backward" but only pictures that belong to event recordings<br />peek live picture = display only one actual live picture<br />next detected motion = like "play forward" but only pictures with motion in it (if no MOS search area is defined in GscView the whole picture size is used for it) are displayed; the display stops after motion is detected<br />prev detected motion = like "play backward" but only pictures with motion in it (if no MOS search area is defined in GscView the whole picture size is used for it) are displayed; the display stops after motion is detected</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client host</td>
|
||||
<td class="BodyE-Column1-Body2">ClientHost</td>
|
||||
<td class="BodyD-Column1-Body2">Host name of the PC where GSCView is running</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client type</td>
|
||||
<td class="BodyE-Column1-Body1">ClientType</td>
|
||||
<td class="BodyD-Column1-Body1">1 = GSCView
|
||||
<br />All other values are for future use! </td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client account</td>
|
||||
<td class="BodyE-Column1-Body2">ClientAccount</td>
|
||||
<td class="BodyD-Column1-Body2">Windows user account under that GSCView is running</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Viewer3"></a>Viewer play mode changed</h2>
|
||||
<p>Action name:ViewerPlayModeChanged(Viewer, Channel, PlayMode, ChannelTime, ClientHost, ClientType, ClientAccount)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p>The playmode of the viewer with the transmitted global number on some GSCView in the network has been changed.</p>
|
||||
<p> </p>
|
||||
<p>GSCView has fired this notification because the playmode of one of its viewers has been changed via a ViewerConnect, ViewerConnectLive, ViewerSetPlayMode, ViewerPlayFromTime, ViewerJumpByTime or one of the ViewerShowAlarmBy. actions while GSCView is remote controlled or because the user has manually changed the playmode of the viewer in GSCView.</p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1">Viewer</td>
|
||||
<td class="BodyD-Column1-Body1">Global number of a viewer on some GSCView in the network</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2">Channel</td>
|
||||
<td class="BodyD-Column1-Body2">Global number of the media channel, displayed in the viewer</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">play mode</td>
|
||||
<td class="BodyE-Column1-Body1">PlayMode</td>
|
||||
<td class="BodyD-Column1-Body1">play stop = if the viewer is already displaying pictures from that channel, it is stopped; if not the newest picture in the database is displayed<br />play forward = if the viewer is already displaying pictures from that channel, it is displaying pictures in normal speed forward from the actual position; if not display of pictures with normal speed starts at the beginning of the database<br />play backward = if the viewer is already displaying pictures from that channel, it is displaying pictures in normal speed backward from the actual position; if not display of pictures with normal speed starts at the end of the database<br />fast forward = like "play forward" but with high speed<br />fast backward = like "play backward" but with high speed<br />step forward = like "play forward" but only one picture<br />step backward = like "play backward" but only one picture<br />play BOD = display the first (the oldest) picture in the database<br />play EOD = display the last (the newest) picture in the database<br />live = display live pictures<br />next event = like "play forward" but only pictures that belong to event recordings<br />prev event = like "play backward" but only pictures that belong to event recordings<br />peek live picture = display only one actual live picture<br />next detected motion = like "play forward" but only pictures with motion in it (if no MOS search area is defined in GscView the whole picture size is used for it) are displayed; the display stops after motion is detected<br />prev detected motion = like "play backward" but only pictures with motion in it (if no MOS search area is defined in GscView the whole picture size is used for it) are displayed; the display stops after motion is detected</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel time</td>
|
||||
<td class="BodyE-Column1-Body2">ChannelTime</td>
|
||||
<td class="BodyD-Column1-Body2">Timestamp belonging to the picture presented in the viewer directly after the plamode had changed. The parameter is transmitted in the following format:
|
||||
"2009/05/06 14:47:48,359 GMT+02:00"
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client host</td>
|
||||
<td class="BodyE-Column1-Body1">ClientHost</td>
|
||||
<td class="BodyD-Column1-Body1">Host name of the PC where GSCView is running</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client type</td>
|
||||
<td class="BodyE-Column1-Body2">ClientType</td>
|
||||
<td class="BodyD-Column1-Body2">1 = GSCView
|
||||
<br />All other values are for future use!
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client account</td>
|
||||
<td class="BodyE-Column1-Body1">ClientAccount</td>
|
||||
<td class="BodyD-Column1-Body1">Windows user account under that GSCView is running</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a name="Viewer4"></a>Viewer selection changed</h2>
|
||||
<p>Action name:ViewerSelectionChanged(Viewer, Channel, PlayMode, ClientHost, ClientType, ClientAccount)</p>
|
||||
<p>Action category: notification</p>
|
||||
<p> </p>
|
||||
<p>The active viewer on some GSCView in the network has been changed.</p>
|
||||
<p>GSCView has fired this notification because the user has selected one of its viewers by mouse click or by dragging a camera onto one of its viewers.</p>
|
||||
<p> </p>
|
||||
<p>GSCView only fires the notification, if a camera is displayed on the selected viewer.</p>
|
||||
<table style="caption-side: top;mc-table-style: url('../Resources/TableStyles/TABLE.css');margin-left: 0;margin-right: auto;" class="TableStyle-Rows" cellspacing="0">
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col style="width: 100px;" class="Column-Column1" />
|
||||
<col class="Column-Column1" />
|
||||
<thead>
|
||||
<tr class="Head-Header1">
|
||||
<th class="HeadE-Column1-Header1" colspan="2">Parameter</th>
|
||||
<th class="HeadD-Column1-Header1">Function</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">viewer</td>
|
||||
<td class="BodyE-Column1-Body1">Viewer</td>
|
||||
<td class="BodyD-Column1-Body1">Global number of a viewer on some GSCView in the network</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">channel</td>
|
||||
<td class="BodyE-Column1-Body2">Channel</td>
|
||||
<td class="BodyD-Column1-Body2">Global number of the media channel, displayed in the viewer</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">play mode</td>
|
||||
<td class="BodyE-Column1-Body1">PlayMode</td>
|
||||
<td class="BodyD-Column1-Body1">play stop = if the viewer is already displaying pictures from that channel, it is stopped; if not the newest picture in the database is displayed<br />play forward = if the viewer is already displaying pictures from that channel, it is displaying pictures in normal speed forward from the actual position; if not display of pictures with normal speed starts at the beginning of the database<br />play backward = if the viewer is already displaying pictures from that channel, it is displaying pictures in normal speed backward from the actual position; if not display of pictures with normal speed starts at the end of the database<br />fast forward = like "play forward" but with high speed<br />fast backward = like "play backward" but with high speed<br />step forward = like "play forward" but only one picture<br />step backward = like "play backward" but only one picture<br />play BOD = display the first (the oldest) picture in the database<br />play EOD = display the last (the newest) picture in the database<br />live = display live pictures<br />next event = like "play forward" but only pictures that belong to event recordings<br />prev event = like "play backward" but only pictures that belong to event recordings<br />peek live picture = display only one actual live picture<br />next detected motion = like "play forward" but only pictures with motion in it (if no MOS search area is defined in GscView the whole picture size is used for it) are displayed; the display stops after motion is detected<br />prev detected motion = like "play backward" but only pictures with motion in it (if no MOS search area is defined in GscView the whole picture size is used for it) are displayed; the display stops after motion is detected</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client host</td>
|
||||
<td class="BodyE-Column1-Body2">ClientHost</td>
|
||||
<td class="BodyD-Column1-Body2">Host name of the PC where GSCView is running</td>
|
||||
</tr>
|
||||
<tr class="Body-Body1">
|
||||
<td class="BodyE-Column1-Body1">client type</td>
|
||||
<td class="BodyE-Column1-Body1">ClientType</td>
|
||||
<td class="BodyD-Column1-Body1">1 = GSCView
|
||||
<br />All other values are for future use!
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="Body-Body2">
|
||||
<td class="BodyE-Column1-Body2">client account</td>
|
||||
<td class="BodyE-Column1-Body2">ClientAccount</td>
|
||||
<td class="BodyD-Column1-Body2">Windows user account under that GSCView is running</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user