Files
geutebruck/GeViSoft_SDK_Docs/chunk_006_pages_51-60.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

195 lines
9.5 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.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

================================================================================
PAGE 51
================================================================================
Prerequisites
1.PleasesetuptheGeViScope SDKonyourdevelopment machineifyouhavenotdone
ityet.
2.Configure GscViewasdescribed inthechapterRemotecontrolGscView byactionin
theGeViScope SDKdocumentation. CheckthatfromGSCPLCSimulator youcan
switchbetweenthescenes.
3.Configure aconnection toGeViScope asdescribed inConnection toGeViScope
(optional).
4.YoushouldnowhaveaGscViewsetupwithtwoscenes:MyStartScene andMyScene
thatcanberemotecontrolled.
Configuring theAlarm
1.Configure thealarmasdescribed inConfiguring anAlarm.
2.Afterthat,themonitorgroupmustbemappedtoaGscViewScene.GeViSoftusesthe
CrossSwitchWithAlarm actiontoroutethevideotothemonitorgroupinternally. There-
foretheseactionsmustbemappedtoGSCViewer Controlactions(e.g.VCChange
SceneByName).ThisisdoneinGeViSetbyaddinganewActionmapping:
c)Thischangesthesceneintheviewer.Afterthat,channel4mustberoutedto
viewer1101inthescene.Forthat,addanotheroutputactiontothesetbypressing
the+button:
d)AddtheViewerconnectliveactionwiththeGeviScope alias=GEVISCOPE ,the
viewer=1101,thechannel=4,andCaption=ViewerConnectLive (1101,4)
================================================================================
PAGE 52
================================================================================
a)AsInputactionselectCrossSwitchWithAlarm withVideoInput =4,VideoOutput =
1,andCaption=CrossSwitchWithAlarm (4,1)
b)Tochangethesceneintheviewertherearedifferentpossibilities. Youcaneither
callVCChangeSceneByName ordirectlyconnectalivestreamtoaviewernumber.
ThisisdonebysendingaViewerConnectLive action.Here,channel4mustbe
routedtoviewer1101inthescene.Forthat,addanoutputactiontothesetbypress-
ingthe+button:
c)AddtheViewerconnectliveactionwiththeGeviScope alias=GEVISCOPE ,the
viewer=1101,thechannel=4,andCaption=ViewerConnectLive (1101,4)
d)TheActionmappingsettingswindowshouldlooklikethis:
================================================================================
PAGE 53
================================================================================
Switching Video1
e)NowrepeattheprocessfortheCrossSwitchWithAlarm actionforvideoinput7
andviewer1102.
================================================================================
PAGE 54
================================================================================
f)Ifexecuted, themappings abovewillswitchthescenetoMySceneinGscView
androutethevideochannelstotherespective viewer.Execution oftheCross-
SwitchWithAlarm actionstakesplaceatthemomentoftriggeringthealarminGeV-
iSoft.
3.Afterquittingthealarmthe4-by-4sceneMyStartScene mustbereloadedinGscView,
according tothescenario.ThiscanbedoneasanOnquitactionoftheGeViSetalarm:
a)IntheGeViSet AlarmsettingsoftheParkingLot alarm,addaVCchangesceneby
nameactiontotheOnquitlist.
================================================================================
PAGE 55
================================================================================
b)ChosetheactionfromGSC:VieweractionandsetGeviScope aliastoGEV-
ISCOPE,viewerto1000,scenetoMyStartScene ,andCaptiontoVCChan -
geSceneByName (1000,MyStartScene ).
c)Sendthesetuptotheserver.
4.OpenGeViAPITestClientandGscViewtotestyournewconfiguration. Onstarting
thealarmbyleftclickinginput1inGeViSet,thesceneshouldswitchtoMyScenein
GscViewwithchannel4beingdisplayedinviewer1101andchannel7inviewer1102.
Onquittingthealarmbyleftclickinginput3inGeViAPITestClient,thesceneshould
switchbacktoMyStartScene .
================================================================================
PAGE 56
================================================================================
SDKUsage
Introduction
Itisrecommended tobefamiliarwiththeGeViSoftsystem,thepossibilities ofmodernvideo
surveillance systemsandvideomanagement systemsingeneral.Beforestartingpro-
gramming yourcustomGeViSoftapplication, youshouldunderstand thebasicsofaction,
alarm,andeventhandlinginGeViSoft, aswellastheprinciplesofclient-servernetworkcom-
munication.
Thefollowingsectionssupportyouwithsomesuggestions andhintsaboutusingtheSDK
interfaces.
General Hints
YoucanalwaysmonitortheactionssentbytheGeViServer oryourapplication insidethe
GeViAPITestClient.Furthermore, thisapplication allowsyoutosendactionsanddatabase
queries.Itislocatedinthe%GEVISOFTSDKPATH% .
 NOTICE
Onadevelopment system itisrecommended tostartGeViServer withthestartserver.bat script
orfromacommand prompt inconsole mode(geviserver.exe console ).Thisallowsyouto
monitor theservers outputduringyourdevelopment.
 WARNING
Makesuretodeleteallobjects thatarecreated insideofDLLs.TheSDKoffersaDeleteObject ()
method fortheseobjects.
 NOTICE
================================================================================
PAGE 57
================================================================================
Callback functions whicharecalledoutoftheSDKDLLsarecalledfromthreads. Thesewere
created insidetheDLLs.Variables andpointers thatarepassed asarguments ofthecallback
maynotbeusedoutside thecallback context. Theyareonlyvalidfortheduration ofthecallback
call.
 NOTICE
Structures thatareusedasarguments forSDKfunctions shouldalwaysbeinitialized byuseof
thefunction memset ().Ifthestructure contains asizeorstructsize element, thenithastobe
initialized withthesizeof()function.
================================================================================
PAGE 58
================================================================================
Overview oftheSDKsInterfaces forC++andDelphiusers
 NOTICE
Thefollowing paragraphs describe theSDKusagefromC++andDelphi. Foradescription ofthe
.NetInterfaces seechapter C#and.Netspecifics
GeViProcAPI
TheSDKisbasedontwoDLLsandthecorresponding headers.TheGeViProcAPI.dll incon-
nectionwiththeGSCActions.dll implements alltheSDKsfunctionality. GSCActions.dll is
usedtoallowtheinteroperability betweenGeViSoftandGeViScope. ItmakestheGeV-
iScopeactionsavailabletoyourGeViSoftapplication. Thecorresponding headersandPas-
calfilesallowyoutoaccessthefunctionsprovidedbytheseDLLsdirectly.
GeViSoftisaclient/server architecture andbasedonacentraldatabasemanagedbythe
GeViServer. ThisisreflectedinthefunctioncallsprovidedbytheSDK.Therearefourmajor
functiontypesdeclaredinGeViProcAPI. Theycanbedistinguished bytheirprefixes:
GeViAPI_ Database_
ThesedatabasefunctionsallowyoutointeractwithGeViSoftserverdirectly.Theyare
theonesyounormallyusefordeveloping yourapplication.
Example:GeViAPI_Database_ Connect()isusedtoconnectyourapplication tothe
server.
GeViAPI_ DeviceClient_
TheDeviceClient functionsareusedbytheGeViIOclientinternally. Theyareusuallynot
ofinterestforSDKdevelopers.
GeViAPI_ SetupClient_
================================================================================
PAGE 59
================================================================================
TheSetupClient functionsareusedbyGeViSettochangetheserversetup.Theyare
usuallynotofinterestforSDKdevelopers.
GeViAPI_
Thesearegeneralhelperfunctionsneededforcarryingoutstandardtasksinyourappli-
cation.
Example:GeViAPI_FreePointer ()to releasememoryallocatedbyyourobjectsinside
theDLLthreads.
GeViProcAPI providesflatfunctioncallsforcommunicating withaGeViServer. Togiveyoua
moreconvenient andobjectorientedoptiontodevelopyourapplication, anotherabstraction
layerhasbeenaddedtotheSDK.ThislayerhidestheflatfunctioncallstotheGeViProcAPI
fromyou.Itsfunctionality canbefoundintheGeViAPIClient headersandC++files.
Foracomprehensive description ofthesefunctions, pleaseconsulttheGeViSoftAPIDoc-
umentation whichisdeliveredwiththeGeViSoftAPISDK.
GeViAPIClient
GeViAPIClient asanabstraction layerusestheflatfunctionsprovidedbyGeViProcAPI and
encapsulates themintoaCGeViAPIClient class.Youcaninstantiate anobjectofthisclass
anduseitsprovidedmethodstohandlethecommunication withtheGeViServer.
Foracomprehensive description ofthesefunctions, pleaseconsulttheGeViSoftAPIDoc-
umentation whichisdeliveredwiththeGeViSoftAPISDK.
================================================================================
PAGE 60
================================================================================
Configuring yourIDEforGeViSoft Projects
VisualStudio2008,C++
1.)AddGeViSofts headerandcppfilestoyourproject.
(YoucandothisbydragginganddroppingtheGeViScopeSDK\Include folderandtheGeV-
iSoftSDK\Include folderfrom%GEVISOFTSDKPATH%\Examples\VS2008CPP toyour
project.)
2.)AddtheSDKsincludefilestoyourprojectbyadding
$(GEVISOFTSDKPATH) \Examples\VS2008CPP\GeViScopeSDK\Include
and
$(GEVISOFTSDKPATH) \Examples\VS2008CPP\GeViSoftSDK\Include
toyourConfiguration Properties ->C/C++->General>Additional IncludeDirectories
3.)IntheConfiguration Properties ->C/C++->Preprocessor tabaddthePreprocessor Def-
initionGEVI_GSC_INCLUDE
4.)Intheprojectsproperties TABConfiguration Properties ->Linker->Generaladd
$(GEVISOFTSDKPATH) \Examples\VS2008CPP\GeViScopeSDK\lib
and
$(GEVISOFTSDKPATH) \Examples\VS2008CPP\GeViSoftSDK\lib
totheAdditional LibraryDirectories ofyourproject
5.)Intheprojectsproperties TABConfiguration Properties ->Linker->Input->Additional
Dependencies addGeViProcAPI.lib andGscActions.lib
6.)MakesurethatyouroutputfilecanfindthepathtoGeViProcAPI andGscActions DLLs.
Itisrecommended tosetConfiguration Properties ->Linker->General->OutputFileto
$(GEVISOFTSDKPATH) \$(ProjectName).exe orcopytheDLLsintotheapplications folder.
7.)SettheConfiguration Properties ->Debugging ->Command toyourexecutables name: