onvif-python 0.0.1__py3-none-any.whl

onvif/services/accesscontrol.py

@@ -0,0 +1,105 @@
+# onvif/services/accesscontrol.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class AccessControl:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("accesscontrol")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="AccessControl",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def GetAccessPointInfoList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAccessPointInfoList", Limit=Limit, StartReference=StartReference
+        )
+
+    def GetAccessPointInfo(self, Token):
+        return self.operator.call("GetAccessPointInfo", Token=Token)
+
+    def GetAccessPointList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAccessPointList", Limit=Limit, StartReference=StartReference
+        )
+
+    def GetAccessPoints(self, Token):
+        return self.operator.call("GetAccessPoints", Token=Token)
+
+    def CreateAccessPoint(self, AccessPoint):
+        return self.operator.call("CreateAccessPoint", AccessPoint=AccessPoint)
+
+    def SetAccessPoint(self, AccessPoint):
+        return self.operator.call("SetAccessPoint", AccessPoint=AccessPoint)
+
+    def ModifyAccessPoint(self, AccessPoint):
+        return self.operator.call("ModifyAccessPoint", AccessPoint=AccessPoint)
+
+    def DeleteAccessPoint(self, Token):
+        return self.operator.call("DeleteAccessPoint", Token=Token)
+
+    def SetAccessPointAuthenticationProfile(self, Token, AuthenticationProfileToken):
+        return self.operator.call(
+            "SetAccessPointAuthenticationProfile",
+            Token=Token,
+            AuthenticationProfileToken=AuthenticationProfileToken,
+        )
+
+    def DeleteAccessPointAuthenticationProfile(self, Token):
+        return self.operator.call("DeleteAccessPointAuthenticationProfile", Token=Token)
+
+    def GetAreaInfoList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAreaInfoList", Limit=Limit, StartReference=StartReference
+        )
+
+    def GetAreaInfo(self, Token):
+        return self.operator.call("GetAreaInfo", Token=Token)
+
+    def GetAreaList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAreaList", Limit=Limit, StartReference=StartReference
+        )
+
+    def GetAreas(self, Token):
+        return self.operator.call("GetAreas", Token=Token)
+
+    def CreateArea(self, Area):
+        return self.operator.call("CreateArea", Area=Area)
+
+    def SetArea(self, Area):
+        return self.operator.call("SetArea", Area=Area)
+
+    def ModifyArea(self, Area):
+        return self.operator.call("ModifyArea", Area=Area)
+
+    def DeleteArea(self, Token):
+        return self.operator.call("DeleteArea", Token=Token)
+
+    def GetAccessPointState(self, Token):
+        return self.operator.call("GetAccessPointState", Token=Token)
+
+    def EnableAccessPoint(self, Token):
+        return self.operator.call("EnableAccessPoint", Token=Token)
+
+    def DisableAccessPoint(self, Token):
+        return self.operator.call("DisableAccessPoint", Token=Token)
+
+    def ExternalAuthorization(
+        self, AccessPointToken, Decision, CredentialToken=None, Reason=None
+    ):
+        return self.operator.call(
+            "ExternalAuthorization",
+            AccessPointToken=AccessPointToken,
+            CredentialToken=CredentialToken,
+            Reason=Reason,
+            Decision=Decision,
+        )

onvif/services/accessrules.py

@@ -0,0 +1,47 @@
+# onvif/services/accessrules.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class AccessRules:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("accessrules")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="AccessRules",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def GetAccessProfileInfo(self, Token):
+        return self.operator.call("GetAccessProfileInfo", Token=Token)
+
+    def GetAccessProfileInfoList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAccessProfileInfoList", Limit=Limit, StartReference=StartReference
+        )
+
+    def GetAccessProfiles(self, Token):
+        return self.operator.call("GetAccessProfiles", Token=Token)
+
+    def GetAccessProfileList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAccessProfileList", Limit=Limit, StartReference=StartReference
+        )
+
+    def CreateAccessProfile(self, AccessProfile):
+        return self.operator.call("CreateAccessProfile", AccessProfile=AccessProfile)
+
+    def ModifyAccessProfile(self, AccessProfile):
+        return self.operator.call("ModifyAccessProfile", AccessProfile=AccessProfile)
+
+    def SetAccessProfile(self, AccessProfile):
+        return self.operator.call("SetAccessProfile", AccessProfile=AccessProfile)
+
+    def DeleteAccessProfile(self, Token):
+        return self.operator.call("DeleteAccessProfile", Token=Token)

onvif/services/actionengine.py

@@ -0,0 +1,46 @@
+# onvif/services/actionengine.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class ActionEngine:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("actionengine")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="ActionEngine",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def GetSupportedActions(self):
+        return self.operator.call("GetSupportedActions")
+
+    def GetActions(self):
+        return self.operator.call("GetActions")
+
+    def CreateActions(self, Action):
+        return self.operator.call("CreateActions", Action=Action)
+
+    def DeleteActions(self, Token):
+        return self.operator.call("DeleteActions", Token=Token)
+
+    def ModifyActions(self, Action):
+        return self.operator.call("ModifyActions", Action=Action)
+
+    def GetActionTriggers(self):
+        return self.operator.call("GetActionTriggers")
+
+    def CreateActionTriggers(self, ActionTrigger):
+        return self.operator.call("CreateActionTriggers", ActionTrigger=ActionTrigger)
+
+    def DeleteActionTriggers(self, Token):
+        return self.operator.call("DeleteActionTriggers", Token=Token)
+
+    def ModifyActionTriggers(self, ActionTrigger):
+        return self.operator.call("ModifyActionTriggers", ActionTrigger=ActionTrigger)

onvif/services/analytics/analytics.py

@@ -0,0 +1,60 @@
+# onvif/services/analytics/analytics.py
+
+from ...operator import ONVIFOperator
+from ...utils import ONVIFWSDL
+
+
+class Analytics:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("analytics", "ver20")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="Analytics",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def GetSupportedAnalyticsModules(self, ConfigurationToken):
+        return self.operator.call(
+            "GetSupportedAnalyticsModules", ConfigurationToken=ConfigurationToken
+        )
+
+    def CreateAnalyticsModules(self, ConfigurationToken, AnalyticsModule):
+        return self.operator.call(
+            "CreateAnalyticsModules",
+            ConfigurationToken=ConfigurationToken,
+            AnalyticsModule=AnalyticsModule,
+        )
+
+    def DeleteAnalyticsModules(self, ConfigurationToken, AnalyticsModuleName):
+        return self.operator.call(
+            "DeleteAnalyticsModules",
+            ConfigurationToken=ConfigurationToken,
+            AnalyticsModuleName=AnalyticsModuleName,
+        )
+
+    def GetAnalyticsModules(self, ConfigurationToken):
+        return self.operator.call(
+            "GetAnalyticsModules", ConfigurationToken=ConfigurationToken
+        )
+
+    def GetAnalyticsModuleOptions(self, ConfigurationToken, Type=None):
+        return self.operator.call(
+            "GetAnalyticsModuleOptions",
+            Type=Type,
+            ConfigurationToken=ConfigurationToken,
+        )
+
+    def ModifyAnalyticsModules(self, ConfigurationToken, AnalyticsModule):
+        return self.operator.call(
+            "ModifyAnalyticsModules",
+            ConfigurationToken=ConfigurationToken,
+            AnalyticsModule=AnalyticsModule,
+        )
+
+    def GetSupportedMetadata(self, Type=None):
+        return self.operator.call("GetSupportedMetadata", Type=Type)

onvif/services/analytics/ruleengine.py

@@ -0,0 +1,44 @@
+# onvif/services/analytics/ruleengine.py
+
+from ...operator import ONVIFOperator
+from ...utils import ONVIFWSDL
+
+
+class RuleEngine:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("ruleengine", "ver20")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="Analytics",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetSupportedRules(self, ConfigurationToken):
+        return self.operator.call(
+            "GetSupportedRules", ConfigurationToken=ConfigurationToken
+        )
+
+    def CreateRules(self, ConfigurationToken, Rule):
+        return self.operator.call(
+            "CreateRules", ConfigurationToken=ConfigurationToken, Rule=Rule
+        )
+
+    def DeleteRules(self, ConfigurationToken, RuleName):
+        return self.operator.call(
+            "DeleteRules", ConfigurationToken=ConfigurationToken, RuleName=RuleName
+        )
+
+    def GetRules(self, ConfigurationToken):
+        return self.operator.call("GetRules", ConfigurationToken=ConfigurationToken)
+
+    def GetRuleOptions(self, ConfigurationToken, RuleType=None):
+        return self.operator.call(
+            "GetRuleOptions", RuleType=RuleType, ConfigurationToken=ConfigurationToken
+        )
+
+    def ModifyRules(self, ConfigurationToken, Rule):
+        return self.operator.call(
+            "ModifyRules", ConfigurationToken=ConfigurationToken, Rule=Rule
+        )

onvif/services/analyticsdevice.py

@@ -0,0 +1,122 @@
+# onvif/services/analyticsdevice.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class AnalyticsDevice:
+    def __init__(self, xaddr=None, **kwargs):
+        # NOTE (ONVIF 18.12):
+        # The AnalyticsDevice service (AnalyticsDeviceBinding) has been marked as
+        # obsolete since ONVIF Release 18.12. Its functionality has largely been
+        # merged into the Analytics service and, in some cases, Media2.
+        #
+        # This class is kept here only for backward compatibility with older devices
+        # (pre-2019) that may still expose an AnalyticsDevice XAddr.
+        #
+        # In modern ONVIF-compliant devices, you should prefer using the Analytics
+        # service (`onvif/services/analytics.py`). If the device does not advertise
+        # an AnalyticsDevice capability in GetCapabilities → Extension, then calling
+        # this class will result in SOAP faults.
+        #
+        # References:
+        # - ONVIF Release 18.12 (December 2018) Release Notes
+        # - AnalyticsDeviceBinding (ver10/analyticsdevice.wsdl)
+        # - Successor: Analytics Service (ver20/analytics/wsdl/analytics.wsdl)
+        # - Operations: https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/analyticsdevice.wsdl
+
+        definition = ONVIFWSDL.get_definition("analyticsdevice")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="AnalyticsDevice",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def DeleteAnalyticsEngineControl(self, ConfigurationToken):
+        return self.operator.call(
+            "DeleteAnalyticsEngineControl", ConfigurationToken=ConfigurationToken
+        )
+
+    def CreateAnalyticsEngineControl(self, Configuration):
+        return self.operator.call(
+            "CreateAnalyticsEngineControl", Configuration=Configuration
+        )
+
+    def SetAnalyticsEngineControl(self, SetAnalyticsEngineControl, ForcePersistence):
+        return self.operator.call(
+            "SetAnalyticsEngineControl",
+            SetAnalyticsEngineControl=SetAnalyticsEngineControl,
+            ForcePersistence=ForcePersistence,
+        )
+
+    def GetAnalyticsEngineControl(self, ConfigurationToken):
+        return self.operator.call(
+            "GetAnalyticsEngineControl", ConfigurationToken=ConfigurationToken
+        )
+
+    def GetAnalyticsEngineControls(self):
+        return self.operator.call("GetAnalyticsEngineControls")
+
+    def GetAnalyticsEngine(self, ConfigurationToken):
+        return self.operator.call(
+            "GetAnalyticsEngine", ConfigurationToken=ConfigurationToken
+        )
+
+    def GetAnalyticsEngines(self):
+        return self.operator.call("GetAnalyticsEngines")
+
+    def SetVideoAnalyticsConfiguration(self, Configuration, ForcePersistence):
+        return self.operator.call(
+            "SetVideoAnalyticsConfiguration",
+            Configuration=Configuration,
+            ForcePersistence=ForcePersistence,
+        )
+
+    def SetAnalyticsEngineInput(self, Configuration, InputToken):
+        return self.operator.call(
+            "SetAnalyticsEngineInput",
+            Configuration=Configuration,
+            InputToken=InputToken,
+        )
+
+    def GetAnalyticsEngineInput(self, ConfigurationToken):
+        return self.operator.call(
+            "GetAnalyticsEngineInput", ConfigurationToken=ConfigurationToken
+        )
+
+    def GetAnalyticsEngineInputs(self):
+        return self.operator.call("GetAnalyticsEngineInputs")
+
+    def GetAnalyticsDeviceStreamUri(self, StreamSetup, AnalyticsEngineControlToken):
+        return self.operator.call(
+            "GetAnalyticsDeviceStreamUri",
+            StreamSetup=StreamSetup,
+            AnalyticsEngineControlToken=AnalyticsEngineControlToken,
+        )
+
+    def GetVideoAnalyticsConfiguration(self, ConfigurationToken):
+        return self.operator.call(
+            "GetVideoAnalyticsConfiguration", ConfigurationToken=ConfigurationToken
+        )
+
+    def CreateAnalyticsEngineInputs(self, Configuration, ForcePersistence):
+        return self.operator.call(
+            "CreateAnalyticsEngineInputs",
+            Configuration=Configuration,
+            ForcePersistence=ForcePersistence,
+        )
+
+    def DeleteAnalyticsEngineInputs(self, ConfigurationToken):
+        return self.operator.call(
+            "DeleteAnalyticsEngineInputs", ConfigurationToken=ConfigurationToken
+        )
+
+    def GetAnalyticsState(self, AnalyticsEngineControlToken):
+        return self.operator.call(
+            "GetAnalyticsState", AnalyticsEngineControlToken=AnalyticsEngineControlToken
+        )

onvif/services/appmgmt.py

@@ -0,0 +1,40 @@
+# onvif/services/appmgmt.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class AppManagement:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("appmgmt")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="AppManagement",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def Uninstall(self, AppID):
+        return self.operator.call("Uninstall", AppID=AppID)
+
+    def GetInstalledApps(self):
+        return self.operator.call("GetInstalledApps")
+
+    def GetAppsInfo(self, AppID=None):
+        return self.operator.call("GetAppsInfo", AppID=AppID)
+
+    def Activate(self, AppID):
+        return self.operator.call("Activate", AppID=AppID)
+
+    def Deactivate(self, AppID):
+        return self.operator.call("Deactivate", AppID=AppID)
+
+    def InstallLicense(self, License, AppID=None):
+        return self.operator.call("InstallLicense", AppID=AppID, License=License)
+
+    def GetDeviceId(self):
+        return self.operator.call("GetDeviceId")

onvif/services/authenticationbehavior.py

@@ -0,0 +1,83 @@
+# onvif/services/authenticationbehavior.py
+
+from ..operator import ONVIFOperator
+from ..utils import ONVIFWSDL
+
+
+class AuthenticationBehavior:
+    def __init__(self, xaddr=None, **kwargs):
+        definition = ONVIFWSDL.get_definition("authenticationbehavior")
+        self.operator = ONVIFOperator(
+            definition["path"],
+            binding=f"{{{definition['namespace']}}}{definition['binding']}",
+            service_path="AuthenticationBehavior",  # fallback
+            xaddr=xaddr,
+            **kwargs,
+        )
+
+    def GetServiceCapabilities(self):
+        return self.operator.call("GetServiceCapabilities")
+
+    def GetAuthenticationProfileInfo(self, Token):
+        return self.operator.call("GetAuthenticationProfileInfo", Token=Token)
+
+    def GetAuthenticationProfileInfoList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAuthenticationProfileInfoList",
+            Limit=Limit,
+            StartReference=StartReference,
+        )
+
+    def GetAuthenticationProfiles(self, Token):
+        return self.operator.call("GetAuthenticationProfiles", Token=Token)
+
+    def GetAuthenticationProfileList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetAuthenticationProfileList", Limit=Limit, StartReference=StartReference
+        )
+
+    def CreateAuthenticationProfile(self, AuthenticationProfile):
+        return self.operator.call(
+            "CreateAuthenticationProfile", AuthenticationProfile=AuthenticationProfile
+        )
+
+    def SetAuthenticationProfile(self, AuthenticationProfile):
+        return self.operator.call(
+            "SetAuthenticationProfile", AuthenticationProfile=AuthenticationProfile
+        )
+
+    def ModifyAuthenticationProfile(self, AuthenticationProfile):
+        return self.operator.call(
+            "ModifyAuthenticationProfile", AuthenticationProfile=AuthenticationProfile
+        )
+
+    def DeleteAuthenticationProfile(self, Token):
+        return self.operator.call("DeleteAuthenticationProfile", Token=Token)
+
+    def GetSecurityLevelInfo(self, Token):
+        return self.operator.call("GetSecurityLevelInfo", Token=Token)
+
+    def GetSecurityLevelInfoList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetSecurityLevelInfoList", Limit=Limit, StartReference=StartReference
+        )
+
+    def GetSecurityLevels(self, Token):
+        return self.operator.call("GetSecurityLevels", Token=Token)
+
+    def GetSecurityLevelList(self, Limit=None, StartReference=None):
+        return self.operator.call(
+            "GetSecurityLevelList", Limit=Limit, StartReference=StartReference
+        )
+
+    def CreateSecurityLevel(self, SecurityLevel):
+        return self.operator.call("CreateSecurityLevel", SecurityLevel=SecurityLevel)
+
+    def SetSecurityLevel(self, SecurityLevel):
+        return self.operator.call("SetSecurityLevel", SecurityLevel=SecurityLevel)
+
+    def ModifySecurityLevel(self, SecurityLevel):
+        return self.operator.call("ModifySecurityLevel", SecurityLevel=SecurityLevel)
+
+    def DeleteSecurityLevel(self, Token):
+        return self.operator.call("DeleteSecurityLevel", Token=Token)