COLSYS/geutebruck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a92b9095390577031a38173710950b5bf1a3c7a1
geutebruck/GeViScope_SDK_Docs/GeViScope_SDK_Part05_Pages_81-100.txt
Administrator a92b909539 feat: GeViScope SDK integration with C# Bridge and Flutter app 
- Add GeViScope Bridge (C# .NET 8.0) on port 7720
  - Full SDK wrapper for camera control, PTZ, actions/events
  - 17 REST API endpoints for GeViScope server interaction
  - Support for MCS (Media Channel Simulator) with 16 test channels
  - Real-time action/event streaming via PLC callbacks

- Add GeViServer Bridge (C# .NET 8.0) on port 7710
  - Integration with GeViSoft orchestration layer
  - Input/output control and event management

- Update Python API with new routers
  - /api/geviscope/* - Proxy to GeViScope Bridge
  - /api/geviserver/* - Proxy to GeViServer Bridge
  - /api/excel/* - Excel import functionality

- Add Flutter app GeViScope integration
  - GeViScopeRemoteDataSource with 17 API methods
  - GeViScopeBloc for state management
  - GeViScopeScreen with PTZ controls
  - App drawer navigation to GeViScope

- Add SDK documentation (extracted from PDFs)
  - GeViScope SDK docs (7 parts + action reference)
  - GeViSoft SDK docs (12 chunks)

- Add .mcp.json for Claude Code MCP server config

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 08:14:17 +01:00

1612 lines
43 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

================================================================================
GeViScope SDK Documentation - Pages 81 to 100
================================================================================
============================================================
PAGE 81
============================================================
LPS position data
Action name:LPSPositionData(TagID, ScannerID, X, Y, Z, Latitude, Longitude, AreaID,
CellID, Status, TimeStamp, Data, AreaName)
Action category: logical
LPS position data.
Parameter
Function
tag ID
TagID
Tag ID.
scanner ID
ScannerID
Scanner ID or IP Address.
X coordinate X
X coordinate of cartesian coordinates.
Y coordinate Y
Y coordinate of cartesian coordinates.
Z coordinate Z
Z coordinate of cartesian coordinates.
Latitude
Latitude
Latitude of geographic coordinates.
Longitude
Longitude
Longitude of geographic coordinates.
area ID
AreaID
Area ID.
cell ID
CellID
Cell ID.
status
Status
Status.
time stamp
TimeStamp Time stamp.
data
Data
Data received by the positioning system, eg. barcode.
area name
AreaName
Area Name.
LPS query position
Action name:LPSQueryPosition(TagID, ScannerID, Data)
Action category: command
Send position query for a Tag to LPS server.
Parameter
Function
tag ID
TagID
Tag ID.
scanner ID ScannerID Scanner ID or IP Address.
data
Data
Data.
POS
Points of sales (POS) Actions enable the exchange of accompanying meta data between
POS Management Systems and GeViScope/re_porter. With these actions payment pro-
cesses 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, Ter-
minalArticleData and TerminalPaymentData are used by the driver "HUTH". The driver
"HUTH" is a GeViScope Media Plugin, which was developed by GEUTEBRÜCK, to integ-
rate 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 pur-
pose. 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.
============================================================
PAGE 82
============================================================
Barcode data
Action name:BarcodeData(ReaderName, TimeStamp, Barcode)
Action category: notification
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.
Parameter
Function
scanner
ReaderName
Alphanumerical identification of the barcode scanner
time stamp
TimeStamp
Time stamp.
code
Barcode
Alphanumerical field for recording the scanned barcode.
Filling pump status
Action name:FillingPumpStatus(TerminalName, TimeStamp, PumpNo, Status, Amount,
Price, Details) Action category: notification
The "HUTH" driver sends the action for each status change of one filling pump. Via the para-
meter "TerminalName" the concerned device will be identified. The "HUTH" driver is prin-
cipally 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.
Parameter
Function
Terminal
TerminalName
Identifies the affected device. The "HUTH" driver is prin-
cipally able to build up several connections to different Huth
devices. The driver sends the alphanumerical value defined
in his setup as "Interface name".
time stamp
TimeStamp
Time Stamp, when the status change was detected by the
Huth-System
pump no
PumpNo
Number of the filling pump
status
Status
New status of the filling pump
Filling started = Huth-device status "taken off before filling"
Filling stopped = Huth-device status "put back on end of
filling"
Pump released = Huth-device status "disconnect after filling"
Amount message = sum - respectively amount notice of the
filling pump
amount
Amount
Amount of the booking (optional)
price
Price
Sum of the booking (optional)
details
Details
Free text (optional)
Interface raw answer
Action name:InterfaceRawAnswer(InterfaceName, TimeStamp, Data)
Action category: notification
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.
============================================================
PAGE 83
============================================================
Parameter
Function
interface
InterfaceName
Identifies the affected end device. The "HUTH" driver is prin-
cipally able to build up several connections to different Huth
devices. The driver sends the alphanumerical value defined
in his setup as "Interface name".
time stamp
TimeStamp
TimeStamp when the telegram was received from the Huth
system.
answer
Data
The sent telegram in raw format.
Interface raw data
Action name:InterfaceRawData(InterfaceName, TimeStamp, Data)
Action category: notification
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 alpha-
numerical value defined in its setup as "Interface name" The further parameter will be filled
with video meta data by the driver.
Parameter
Function
interface
InterfaceName
Identifies the affected end device. The "HUTH" driver is prin-
cipally able to build up several connections to different Huth
devices. The driver sends the alphanumerical value defined
in his setup as "Interface name".
time stamp
TimeStamp
TimeStamp when the telegram was received from the Huth
system.
data
Data
The received telegram in raw format.
POS data
Action name:POSData(POSName, TimeStamp, Article, Price, Units, PricePerUnit, Line1,
Line2, Line3, Line4, Line5)
Action category: logical
The POS Management System sends the action for each transaction carried out at a cash
point
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
Parameter
Function
POS
POSName
Alphanumerical identification of the cash point
time stamp
TimeStamp
Time Stamp, when the action was send from the POS man-
agement system
article
Article
Identification of the booked article (optional)
price
Price
Amount (single price multiplied with number of articles) of
transaction (optional)
units
Units
Amount of articles of the transaction (optional)
price per unit
PricePerUnit
Single article price of the transaction (optional)
line 1
Line1
Alphanumerical fields /sections for storing of additional
information concerning the transaction or for storing inform-
ation which have been printed out on the sales slip (optional)
line 2
Line2
Alphanumerical fields /sections for storing of additional
information concerning the transaction or for storing inform-
============================================================
PAGE 84
============================================================
Parameter
Function
ation which have been printed out on the sales slip (optional)
line 3
Line3
Alphanumerical fields /sections for storing of additional
information concerning the transaction or for storing inform-
ation which have been printed out on the sales slip (optional)
line 4
Line4
Alphanumerical fields /sections for storing of additional
information concerning the transaction or for storing inform-
ation which have been printed out on the sales slip (optional)
line 5
Line5
Alphanumerical fields /sections for storing of additional
information concerning the transaction or for storing inform-
ation which have been printed out on the sales slip (optional)
POS status
Action name:POSStatus(POSName, TimeStamp, Status, Details)
Action category: logical
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.
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.
The parameter "Status" can be addressed by the POS management system with a code fig-
ure for the currently notified status.
Parameter
Function
POS
POSName
Alphanumerical identification of cash point
time stamp
TimeStamp
Time Stamp, when the action was sent from the POS man-
agement system
status
Status
Identification figure for the currently notified status
details
Details
Additional alphanumerical information from POS management
system (optional)
Terminal article data
Action name:TerminalArticleData(TerminalName, TimeStamp, CashierStation, PumpNo,
AlarmStatus, Amount, Price, Details)
Action category: notification
The "Huth" driver sends the actions for each product-group-booking. Via the parameter "Ter-
minalName" 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.
Parameter
Function
Terminal
TerminalName
Identifies the affected device. The "HUTH" driver is prin-
cipally able to build up several connections to different Huth
devices. The driver sends the alphanumerical value defined
in his setup as "Interface name".
time stamp
TimeStamp
Time Stamp, when the status change was detected by the
Huth-System
cashier station
CashierStation
Number of the cash point where the booking is carried out
pump no
PumpNo
Number of the filling point
alarm
AlarmStatus
Status of Alarm-Flags
Yes = Alarm-Flag was set by the Huth system
No = Alarm-Flag not set
============================================================
PAGE 85
============================================================
Parameter
Function
amount
Amount
Amount of the booking (optional)
price
Price
Sum of the booking (optional)
details
Details
Free text (optional)
Terminal payment data
Action name:TerminalPaymentData(TerminalName, TimeStamp, CashierStation,
PumpNo, AlarmStatus, Amount, Price, Details)
Action category: notification
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 fur-
ther parameter will be filled with video meta data via the driver.
Parameter
Function
Terminal
TerminalName
Identifies the affected device. The "HUTH" driver is prin-
cipally able to build up several connections to different Huth
devices. The driver sends the alphanumerical value defined
in his setup as "Interface name".
time stamp
TimeStamp
Time Stamp, when the status change was detected by the
Huth-System
cashier station
CashierStation
Number of the cash point where the booking is carried out
with the used payment method
pump no
PumpNo
Number of the filling point (optional)
alarm
AlarmStatus
Status of Alarm-Flags
Yes = Alarm-Flag was set by the Huth system
No = Alarm-Flag not set
amount
Amount
Amount of the booking (optional)
price
Price
Sum of the booking (optional)
details
Details
Free text (optional)
Remote export
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 ("SetEx-
portMarker" 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
============================================================
PAGE 86
============================================================
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 sys-
tems over the network. Exports that have been started locally in GSCView cannot be con-
trolled 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.
Cancel export
Action name:CancelExport(ExportID, AbortFlag)
Action category: command
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.
Parameter
Function
export GUID
ExportID
ID of the export process that has to be aborted.
The export GUID is being assigned on the action "StartRe-
moteExport".
e.g.: 01E68451-2406-484d-A9BC-5140762931E0
abort flag
AbortFlag
reason for abort
0: user abort; abort of export through user
1: low disc space; too little storage capacity
2: no user rights; access based on restricted user rights not pos-
sible
3: error; internal error
Export finished
Action name:ExportFinished(ExportID, Success)
Action category: notification
The GSCRemEx service notifies through this action that the running process was com-
pleted.
Possible status messages are: user abort, low disc space, no user rights, error.
Parameter
Function
export GUID
ExportID
ID of completed export process. The export GUID is being assigned
on the action "StartRemoteExport".
e.g.: 01E68451-2406-484d-A9BC-5140762931E0
success
Success
reason for abort
0: user abort; abort of export through user
1: low disc space; too little storage capacity
2: no user rights; access based on restricted user rights not pos-
sible
3: error; internal error
Export progress
Action name:ExportProgress(ExportID, Progress)
Action category: notification
The GSCRemEx service notifies the current status of the running export process in %.
Parameter
Function
export GUID
ExportID
ID of running export. The export GUID is being assigned on the
action "StartRemoteExport".
e.g.: 01E68451-2406-484d-A9BC-5140762931E0
progress
Progress
shows current status of the export process in %
============================================================
PAGE 87
============================================================
Initialize remote export
Action name:InitializeRemoteExport(Viewer, Device)
Action category: command
This action is being used especially in the context of control units or systems like for
example the PILOT.
The PILOT center device notifies GSCView that a new export has to be initiated. Thereupon
GSCView creates the action "StartRemoteExport" with the appropriate parameters.
Parameter
Function
viewer
Viewer
global viewer number
device GUID
Device
ID of the PILOT center device (transmitted by the PILOT itself)
e.g.: 01E68451-2406-484d-A9BC-5140762931E0
Set export marker
Action name:SetExportMarker(Viewer, Marker)
Action category: command
This action is being used especially in the context of control units or systems like for
example the PILOT.
It indicates GSCView that an export start and end point has to be set on the current position
of viewer X.
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.
Parameter
Function
viewer
Viewer
global viewer number
marker
Marker
tags and stores the start and end point of the data that has to be
exported
(selection begin=0, selection end=1)
Start remote export
Action name:StartRemoteExport(ExportID, Device, BackupFormat, Channel, Selec-
tionBegin, SelectionEnd, JobID)
Action category: command
This action tells the GSCRemEx service to start a new export.
The action "StartRemoteExport" was created because the PILOT or another external soft-
ware system did send the action "InitializeRemoteExport" to GSCView before.
Parameter
Function
export GUID
ExportID
ID of running exports. The export GUID has to be determined sep-
arately in advance because the action itself does not create a
GUID.
device GUID
Device
ID of PILOT center device. If no PILOT is being used the blank
GUID can be used instead.
e.g.: 01E68451-2406-484d-A9BC-5140762931E0
format
BackupFormat
defines the format of the exported file
0=default (in this case it equals 1=GBF)
1=GBF( GEUTEBRUECK backup file)
2=MPEG2
channel
Channel
global channel number/camera number
start time
SelectionBegin
holds the position of the marker for the start point ("selection
begin")
end time
SelectionEnd
holds the position of the marker for the end point ("selection end")
============================================================
PAGE 88
============================================================
Parameter
Function
job ID
JobID
Contains the login data (server name, user name, encoded pass-
word)
Optional second user password. The login data is separated by |.
e.g.: <server name>|<user>|<PW>|<user2>|<PW2>
localhost|admin|test|
If there is no second user (second user password) nothing has to
be
entered at this point.
Passwords in this parameter are encoded. Therefor the function
DBIEncodeString() of GscDBI-DLL (from GeViScope/re_porter
SDK) is being used.
Start scene store
Action name:StartSceneStore(SceneStoreID, CutList, PreHistoryLength, Record-
ingLength)
Action category: command
For internal use only!
Parameter
Function
scene store
GUID
SceneStoreID
Scene store GUID.
cut-list
CutList
Cut-list.
pre-history
length
PreHistoryLength Pre-history length.
recording
length
RecordingLength Recording length.
SKIDATA
SKIDATA messages.
SKIDATA control
Action name:SkidataControl(InterfaceName, Data)
Action category: logical
SKIDATA control information.
Parameter
Function
interface InterfaceName Interface name.
state
Data
Interface state.
SKIDATA device event
Action name:SkidataDeviceEvent(InterfaceName, DeviceID, EventCode)
Action category: logical
SKIDATA device event.
Parameter
Function
interface
InterfaceName Interface name.
device
DeviceID
Device ID.
event code EventCode
Event code.
SKIDATA entry
Action name:SkidataEntry(InterfaceName, MessageCode, TranscactionID, CarParkNo,
DeviceID)
============================================================
PAGE 89
============================================================
Action category: logical
SKIDATA entry.
Parameter
Function
interface
InterfaceName Interface name.
message
MessageCode
Message code.
transaction TranscactionID Transcaction ID.
car park
CarParkNo
Car park no.
device
DeviceID
Device ID.
SKIDATA exit
Action name:SkidataExit(InterfaceName, MessageCode, TranscactionID, CarParkNo,
DeviceID)
Action category: logical
SKIDATA exit.
Parameter
Function
interface
InterfaceName Interface name.
message
MessageCode
Message code.
transaction TranscactionID Transcaction ID.
car park
CarParkNo
Car park no.
device
DeviceID
Device ID.
SKIDATA transaction
Action name:SkidataTransaction(InterfaceName, MessageCode, TranscactionID,
CarParkNo, DeviceID)
Action category: logical
SKIDATA transaction.
Parameter
Function
interface
InterfaceName Interface name.
message
MessageCode
Message code.
transaction TranscactionID Transcaction ID.
car park
CarParkNo
Car park no.
device
DeviceID
Device ID.
System actions
All actions describing system behaviour.
Custom action
Action name:CustomAction(Int, String)
Action category: logical
This action has no side effects and can be used for customer purposes.
Parameter
Function
INT parameter
Int
Numeric parameter.
STRING parameter String Literal parameter.
Database recording info per ring
Action name:DatabaseRecordingInfoRing(DatabaseRing, NoVideoRecording, NoAu-
dioRecording, NoRecordingAtAll, VideoSamplesPerSecond, VideoMBPerSecond, Audi-
oSamplesPerSecond, AudioMBPerSecond, WriteWaitTimesPercent, RingCapacity,
OldestItem, RecordingDepth, EstimatedRequiredCapacity)
============================================================
PAGE 90
============================================================
Action category: logical
Database recording info per ring.
Parameter
Function
database ring
DatabaseRing
Database ring.
no video recording
NoVideoRecording
Video is recording or not.
no audio recording
NoAudioRecording
Audio is recording or not.
no recording
NoRecordingAtAll
Video and/or audio is recording or not.
video samples/s
VideoSamplesPerSecond
Video samples per second.
video samples MB/s
VideoMBPerSecond
Video MB per second.
audio samples/s
AudioSamplesPerSecond
Audio samples per second.
audio samples MB/s
AudioMBPerSecond
Audio MB per second.
write wait %
WriteWaitTimesPercent
Write wait times in percent.
ring capacity
RingCapacity
Ring capacity.
oldest item
OldestItem
Time stamp of the oldest item.
recording depth
RecordingDepth
Recording depth in hours.
estimated required capacity EstimatedRequiredCapacity Estimated required capacity.
Database recording info total
Action name:DatabaseRecordingInfoTotal(NoVideoRecording, NoAudioRecording, NoRe-
cordingAtAll, VideoSamplesPerSecond, VideoMBPerSecond, AudioSamplesPerSecond,
AudioMBPerSecond, WriteWaitTimesPercent, TotalCapacity, FreeCapacity, Alloc-
atedCapacity, OldestItem, RecordingDepth, EstimatedRequiredCapacity, RequiredCa-
pacityFactor, RequiredCapacityAvailable)
Action category: logical
Database recording info total.
Parameter
Function
no video recording
NoVideoRecording
Video is recording or not.
no audio recording
NoAudioRecording
Audio is recording or not.
no recording
NoRecordingAtAll
Video and/or audio is recording or not.
video samples/s
VideoSamplesPerSecond
Video samples per second.
video samples MB/s
VideoMBPerSecond
Video MB per second.
audio samples/s
AudioSamplesPerSecond
Audio samples per second.
audio samples MB/s
AudioMBPerSecond
Audio MB per second.
write wait %
WriteWaitTimesPercent
Write wait times in percent.
total capacity
TotalCapacity
Total capacity.
free capacity
FreeCapacity
Free capacity.
allocated capacity
AllocatedCapacity
Allocated capacity.
oldest item
OldestItem
Time stamp of the oldest item.
recording depth
RecordingDepth
Recording depth in hours.
estimated required capacity EstimatedRequiredCapacity Estimated required capacity.
required capacity factor
RequiredCapacityFactor
Required capacity factor.
required capacity available
RequiredCapacityAvailable
Required capacity available.
Database started
Action name:DatabaseStarted(Status, TotalSize)
Action category: logical
============================================================
PAGE 91
============================================================
This action will be fired at the database start-up.
Parameter
Function
status
Status
Database status message.
total size TotalSize Database total size.
Event recording changed
Action name:EventRecordingChanged(EventID, TypeID)
Action category: logical
Event recording settings are changed.
Parameter
Function
instance ID EventID Instance ID of the event.
event type
TypeID
Type of the event.
Event started
Action name:EventStarted(EventID, TypeID, ForeignKey)
Action category: logical
Event has started.
Parameter
Function
instance ID EventID
Instance ID of the event.
event type
TypeID
Type of the event.
foreign key
ForeignKey Optional foreign key used to start the alarm.
Event stopped
Action name:EventStopped(EventID, TypeID)
Action category: logical
Event has stopped.
Parameter
Function
instance ID EventID Instance ID of the event.
event type
TypeID
Type of the event.
FRC notification
Action name:FRCNotification(Notification, Param, Description, XMLInfo)
Action category: logical
FRC notification.
Parameter
Function
notification
Notification
Notification reason.
param
Param
Additional parameter.
description
Description Optional notification text.
additional info XMLInfo
Optional additional info (usually as XML string).
GEMOS alarm
Action name:GEMOSalarm(GEMOSkey, GEMOSint, GEMOSstr)
Action category: logical
GEMOS alarm notification.
Parameter
Function
GEMOS key GEMOSkey GEMOS alarm key.
GEMOS int
GEMOSint
GEMOS alarm integer parameter.
GEMOS str
GEMOSstr
GEMOS alarm string parameter.
============================================================
PAGE 92
============================================================
Kill all events
Action name:KillAllEvents()
Action category: logical
Kill all active events.
Kill event
Action name:KillEvent(TypeID)
Action category: logical
Kill event.
Parameter
Function
event type TypeID Type of the event.
Kill event by instance
Action name:KillEventByID(EventID)
Action category: logical
Kill event by instance ID.
Parameter
Function
instance ID EventID Instance ID of the event.
Live check
Action name:LiveCheck(Counter, Date)
Action category: logical
This action will be fired every 10 seconds and intended for use as live check.
Parameter
Function
counter
Counter This is the number of already fired live check actions.
time stamp Date
Current server time.
Set clock
Action name:SetClock(Date)
Action category: logical
Set clock.
Parameter
Function
current time Date
Current time.
Setup changed
Action name:SetupChanged(User, Host, Date, ResourceKind, ResourceID, ChangeKind,
Details, ClientHost, ClientType, ClientAccount)
Action category: logical
Setup changed.
Parameter
Function
user name
User
Name of the user modified the setup.
remote host
Host
Host from where the connection was done.
current time
Date
Current time.
resource kind
ResourceKind Modified resource kind.
resource ID
ResourceID
Modified resource ID.
change kind
ChangeKind
Change kind.
details
Details
Details of the modification.
client host
ClientHost
Host from where the connection is done.
============================================================
PAGE 93
============================================================
Parameter
Function
client type
ClientType
Client type.
client account ClientAccount User account from where the connection is done.
Setup upload progress
Action name:SetupUploadProgress(User1, User2, Host, Progress, Date)
Action category: logical
Setup upload progress.
Parameter
Function
first user
User1
Name of the user modified the setup.
second user
User2
Name of the second user by four eyes authentication.
remote host
Host
Host from where the connection was done.
progress %
Progress Progress in percent.
current time Date
Current stage time.
Set watchdog
Action name:SetWatchdog(Timeout)
Action category: logical
Set watchdog.
Parameter
Function
timeout Timeout Timeout in seconds, before the watchdog must be retriggered and before the
hardware watchdog will set the hardware contact.
SMRP viewer cleared
Action name:SMRPViewerCleared()
Action category: logical
SMRP viewer cleared.
SMRP viewer connected
Action name:SMRPViewerConnected(Server, Channel)
Action category: logical
SMRP viewer connected to the camera.
Parameter
Function
server
Server
Server name.
channel Channel Channel.
SMTP mail
Action name:SMTPMailSend(Subject, To, Cc, Body, Channel)
Action category: logical
This action will send a user defined email if GscMail is connected
Parameter
Function
subject
Subject
Mail subject.
to
To
Mail recepients.
cc
Cc
Carbon copy recepients.
body
Body
Mail body.
channel Channel Channel.
Start event
Action name:StartEvent(TypeID, ForeignKey)
Action category: logical
============================================================
PAGE 94
============================================================
Start event.
Parameter
Function
event type
TypeID
Type of the event.
foreign key ForeignKey Optional foreign key used to store for the alarm.
Stop all events
Action name:StopAllEvents()
Action category: logical
Stop all active events.
Stop event
Action name:StopEvent(TypeID)
Action category: logical
Stop event.
Parameter
Function
event type TypeID Type of the event.
Stop event by instance
Action name:StopEventByID(EventID)
Action category: logical
Stop event by instance ID.
Parameter
Function
instance ID EventID Instance ID of the event.
System error
Action name:SystemError(Source, Message, WindowsError, Description, XMLInfo)
Action category: logical
Notify system error.
Parameter
Function
source subsystem
Source
Source of the message.
message code
Message
Kind of the message.
Windows error code WindowsError Optional Windows error code.
description
Description
Optional description of the message.
additional info
XMLInfo
Optional additional info (usually as XML string).
System info
Action name:SystemInfo(Source, Message, Description, XMLInfo)
Action category: logical
Notify system information.
Parameter
Function
source subsystem Source
Source of the message.
message code
Message
Kind of the message.
description
Description Optional description of the message.
additional info
XMLInfo
Optional additional info (usually as XML string).
System settings changed
Action name:SystemSettingsChanged(SetupChanged, User1, User2, Host,
TimeRangeChanged, TimeRange, LicenceChanged, Date)
Action category: logical
Setup of the system and/or the current time range changed.
============================================================
PAGE 95
============================================================
Parameter
Function
setup changed
SetupChanged
System setup has changed.
first user
User1
Name of the user modified the setup.
second user
User2
Name of the second user by four eyes authentication.
remote host
Host
Host from where the connection was done.
time range changed TimeRangeChanged Time range has changed.
current time range
TimeRange
Currently active time range.
licence changed
LicenceChanged
Licence has changed.
change time
Date
Time of the system settings changed.
System started
Action name:SystemStarted(Date)
Action category: logical
This action will be fired only once at the system start-up.
Parameter
Function
start time Date
Time of the system start-up.
System terminating
Action name:SystemTerminating(Date, WindowsShutdown)
Action category: logical
This action will be fired when the system is going shutdown.
Parameter
Function
stop time
Date
Time of the system shutdown.
Windows shut-
down
WindowsShutdown Indicates whether the system shutdown is done due to the
windows shutdown.
System warning
Action name:SystemWarning(Source, Message, WindowsError, Description, XMLInfo)
Action category: logical
Notify system warning.
Parameter
Function
source subsystem
Source
Source of the message.
message code
Message
Kind of the message.
Windows error code WindowsError Optional Windows error code.
description
Description
Optional description of the message.
additional info
XMLInfo
Optional additional info (usually as XML string).
Transfer binary buffer
Action name:TransferBinaryBuffer(InternalHandle, Parameter)
Action category: logical
Transfer binary buffer.
Parameter
Function
internal handle InternalHandle Internal handle.
parameter
Parameter
Parameter.
Transfer binary channel buffer
Action name:TransferBinaryChannelBuffer(Channel, InternalHandle, Parameter)
Action category: logical
Transfer binary channel buffer.
============================================================
PAGE 96
============================================================
Parameter
Function
channel
Channel
Channel.
internal handle InternalHandle Internal handle.
parameter
Parameter
Parameter.
User login
Action name:UserLogin(User1, User2, Host, ClientHost, ClientType, ClientAccount)
Action category: logical
This action will be fired when the user has connected to the system.
Parameter
Function
first user
User1
Name of the user connected to the system.
second user
User2
Name of the second user by four eyes authentication.
remote host
Host
Host from where the connection is done.
client host
ClientHost
Host from where the connection is done.
client type
ClientType
Client type.
client account ClientAccount User account from where the connection is done.
User login failed
Action name:UserLoginFailed(User1, User2, Host, RejectReason, ClientHost, ClientType,
ClientAccount)
Action category: logical
This action will be fired when the user has tried to connect to the system but was rejected.
Parameter
Function
first user
User1
Name of the user tried to connect to the system.
second user
User2
Name of the second user by four eyes authentication.
remote host
Host
Host from where the connection is done.
reject reason
RejectReason
Reason of the rejection.
client host
ClientHost
Host from where the connection is done.
client type
ClientType
Client type.
client account ClientAccount User account from where the connection is done.
User logout
Action name:UserLogout(User1, User2, Host, ClientHost, ClientType, ClientAccount)
Action category: logical
This action will be fired when the user has disconnected from the system.
Parameter
Function
first user
User1
Name of the user disconnected from the system.
second user
User2
Name of the second user by four eyes authentication.
remote host
Host
Host from where the connection was done.
client host
ClientHost
Host from where the connection is done.
client type
ClientType
Client type.
client account ClientAccount User account from where the connection is done.
Video control actions
All actions to control the video streams, also all notifications about the state change of the
video streams.
============================================================
PAGE 97
============================================================
Activate external process
Action name:ActivateExternalProcess(Channel, TimeStamp, ExternalSystem)
Action category: logical
Activate external process.
Parameter
Function
channel
Channel
Channel.
time stamp
TimeStamp
Time stamp.
external system ExternalSystem External system to activate.
Change AD parameter set
Action name:ChangeADParameterSet(Channel, ParameterSet)
Action category: logical
This action changes the current AD parameter set of the video channel.
Parameter
Function
channel
Channel
Channel.
AD parameter set ParameterSet The name of the new AD parameter set.
Change camera profile
Action name:ChangeCameraProfile(HardwareModule, CameraProfile)
Action category: logical
This action changes the current camera profile of the hardware module.
Parameter
Function
hardware HardwareModule Hardware module.
profile
CameraProfile
The name of the camera profile.
Change CPA parameter set
Action name:ChangeCPAParameterSet(Channel, ParameterSet)
Action category: logical
This action changes the current CPA parameter set of the video channel.
Parameter
Function
channel
Channel
Channel.
CPA parameter set ParameterSet The name of the new CPA parameter set.
Change OBTRACK parameter set
Action name:ChangeObtrackParameterSet(Channel, ParameterSet)
Action category: logical
This action changes the current OBTRACK parameter set of the video channel.
Parameter
Function
channel
Channel
Channel.
OBTRACK parameter set ParameterSet The name of the new OBTRACK parameter set.
Change VMD parameter set
Action name:ChangeVMDParameterSet(Channel, ParameterSet)
Action category: logical
This action changes the current VMD parameter set of the video channel.
Parameter
Function
channel
Channel
Channel.
VMD parameter set ParameterSet The name of the new VMD parameter set.
============================================================
PAGE 98
============================================================
Channel error
Action name:ChannelError(Channel, SensorType, Source, Message, WindowsError,
Description, XMLInfo)
Action category: logical
Notify channel error.
Parameter
Function
channel
Channel
Channel.
sensor type
SensorType
Sensor type.
source subsystem
Source
Source of the message.
message code
Message
Kind of the message.
Windows error code WindowsError Optional Windows error code.
description
Description
Optional description of the message.
additional info
XMLInfo
Optional additional info (usually as XML string).
Channel info
Action name:ChannelInfo(Channel, SensorType, Source, Message, Description, XMLInfo)
Action category: logical
Notify channel information.
Parameter
Function
channel
Channel
Channel.
sensor type
SensorType Sensor type.
source subsystem Source
Source of the message.
message code
Message
Kind of the message.
description
Description
Optional description of the message.
additional info
XMLInfo
Optional additional info (usually as XML string).
Channel live check
Action name:ChannelLiveCheck(Channel, SensorType, TimeStamp)
Action category: logical
This action notifies that the channbel is alive.
Parameter
Function
channel
Channel
Channel.
sensor type SensorType Sensor type.
time stamp
TimeStamp
Time stamp.
Channel warning
Action name:ChannelWarning(Channel, SensorType, Source, Message, WindowsError,
Description, XMLInfo)
Action category: logical
Notify channel warning.
Parameter
Function
channel
Channel
Channel.
sensor type
SensorType
Sensor type.
source subsystem
Source
Source of the message.
message code
Message
Kind of the message.
Windows error code WindowsError Optional Windows error code.
description
Description
Optional description of the message.
additional info
XMLInfo
Optional additional info (usually as XML string).
============================================================
PAGE 99
============================================================
CPA measurement
Action name:CPAMeasurement(Channel, Correlation)
Action category: logical
CPA measurement.
Parameter
Function
channel
Channel
Channel.
correlation Correlation Correlation factor.
IAS settings changed
Action name:IASSettingsChanged(Channel, SensorType)
Action category: logical
IAS settings changed.
Parameter
Function
channel
Channel
Channel.
sensor type SensorType Sensor type.
IP camera raw command
Action name:IPCameraRawCommand(URL, User, Password, POST)
Action category: logical
This action sends a special command to the IP camera.
Parameter
Function
url
URL
Complete command URL (like http://192.168.0.165:80/-
set?daynight=night).
user
User
User name to authenticate by the camera (optional).
password Password Password to authenticate by the camera (optional).
post
POST
POST parameters (optional, separate lines with \\r\\n).
Make CPA reference image
Action name:MakeCPAReferenceImage(Channel)
Action category: logical
Make CPA reference image.
Parameter
Function
channel Channel Channel.
Media channel setup
Action name:MediaChannelSetupInfo(Channel, TimeStamp, Parameter)
Action category: logical
Media channel setup info.
Parameter
Function
channel
Channel
Channel.
time stamp TimeStamp Time stamp.
parameter
Parameter
Parameter.
NPR raw data
Action name:NPRRawData(PlateNo, Country, Channel, TimeStamp, ZoneRect, Weight,
ZoneState, ZonePlace, Speed, Direction, ZoneIndex, CurBest, PlateWidth, PlateHeight,
PlateAngle, SymHeight, Type)
Action category: logical
NPR raw data.
============================================================
PAGE 100
============================================================
Parameter
Function
plate no.
PlateNo
Recognized plate no.
country
Country
Country.
channel
Channel
Channel.
time stamp
TimeStamp Time stamp.
zone rect
ZoneRect
Zone rectangle.
weight
Weight
Weight of recognition.
zone state
ZoneState
Zone state.
zone status
ZonePlace
Zone status.
speed
Speed
Speed in km/h
direction
Direction
Direction of the motion.
zone index
ZoneIndex
Zone index.
best
CurBest
Current recognition is best.
plate width
PlateWidth
Plate width.
plate height
PlateHeight Plate height.
plate angle
PlateAngle
Plate angle.
Symbol height SymHeight
Symbol height.
type
Type
Number type.
NPR recognition
Action name:NPRRecognition(PlateNo, Country, Channel, TimeStamp, ZoneRect, Restric-
tion, Category, Speed, Direction, ZoneIndex, Type, Weight)
Action category: logical
NPR recognition.
Parameter
Function
plate no.
PlateNo
Recognized plate no.
country
Country
Country.
channel
Channel
Channel.
time stamp TimeStamp Time stamp.
zone rect
ZoneRect
Zone rectangle.
restriction
Restriction
Restriction of recognized number.
category
Category
Category of recognized number.
speed
Speed
Speed in km/h
direction
Direction
Direction of the motion.
zone index
ZoneIndex
Zone index.
type
Type
Number type.
weight
Weight
Weight of recognition.
OBTRACK channel counter
Action name:ObtrackChannelCounter(Channel, CounterType, CounterValue, ObjectDir-
ection, TimeStamp, ResetTimeStamp)
Action category: logical
OBTRACK channel counter.
Parameter
Function
channel
Channel
Channel.
counter type
CounterType
Counter type.
counter value
CounterValue
Counter value.
object direction
ObjectDirection
Object direction.
Reference in New Issue View Git Blame Copy Permalink