Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Each macro consists of:

  • guid - an  an id;
  • name - a name;
  • mode - operation mode;
  • conditions - launch conditions;
  • rules - rules.

Operation modes

 mode contains the general information:

  • enabled or disabled - whether the macro is enabled or disabled;
  • user_role - a  a role for which the macro will be available in the layout menu; 
  • is_add_to_menu - add  add macros to the layout menu;
  • time_zone - time zone id, if the macro should be launched on time

    Code Block
    "time_zone": {
                        "timezone_id": "6fb68cf4-ca6a-46a1-b2e3-ab4cfdaa0444"
                    }


  • autorule

    Info
    titleNote

    Contains the general information for launching the automatic rules:

    • zone_ap - a camera under which the rule is created;
    • only_if_armed - operate only in armed mode;
    • timezone_id - id  id of the time zone;.
    Code Block
    "autorule": {
                        "zone_ap": "hosts/Server1/DeviceIpint.30/SourceEndpoint.video:0:0",
                        "only_if_armed": false,
                        "timezone_id": "00000000-0000-0000-0000-000000000000"
                    }



  • continuous

    Info
    titleNote

    Contains the general information for launching the continuous macros:

    • server - a  a Server;
    • timezone_id - id  id of the time zone;
    • heartbeat_ms - launch  launch cycle in millisecond;
    • random - random  random launch of a macro.
    Code Block
     "continuous": {
                        "server": "Server1",
                        "timezone_id": "00000000-0000-0000-0000-000000000000",
                        "heartbeat_ms": 3600000,
                        "random": true
                    }



...

  • detector

    Code Block
    "detector": {
                            "event_type": "sitDown",
                            "source_ap": "hosts/Server1/HumanBoneDetector.1/EventSupplier",
                            "state": "BEGAN",
                            "details": []
                        }


  • timezone

    Code Block
                  "timezone": {
                            "timezone_id": "6fb68cf4-ca6a-46a1-b2e3-ab4cfdaa0444",
                            "boundary_case": "TB_BEGINING"
                        }


  • alert

    Code Block
    "alert": {
        "zone_ap": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0",
        "alert_case": "AC_ALERT_DANGEROUS"
    }


  • device

    Code Block
    "device": {
        "device": "hosts/Server1/DeviceIpint.69",
        "state": "IPDS_CONNECTED",
        "threshold": 0
    }


  • archive_write

    Code Block
    "archive_write": {
        "camera": "hosts/Server1/DeviceIpint.28/SourceEndpoint.video:0:0",
        "state": "ON"
    }


  • relay

    Code Block
    "relay": {
        "relay": "hosts/Server1/DeviceIpint.10/StateControl.relay0:0",
        "state": "ON"
    }


  • volume_health

    Code Block
    "volume_health": {
        "storage": "hosts/Server1/MultimediaStorage.AliceBlue/MultimediaStorage",
        "volume": "",
        "health": "VH_CORRUPTED"
    }


  • server_state

    Info
    titleNote

    observer - a  a server from which the macro is launched;

    subject - a  a server from which the state should be received.

    Code Block
    "server_state": {
        "observer": "Server1",
        "subject": "Server2",
        "state": "SS_OFFLINE"
    }



  • text

    Info
    titleNote

    The Event Source object should be created (see Event source object).

    Code Block
    "text": {
        "source": "hosts/Server1/DeviceIpint.110/SourceEndpoint.textEvent:0",
        "text": "Cash"
    }



  • arm

    Info
    titleNote

    Arming the camera.

    Code Block
    "arm": {
        "zone": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0",
        "state": "CS_ArmPrivate"
    }



  • recognition

    Code Block
    "recognition": {
        "camera": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
        "list": "797703ea-6917-4341-888b-b6f0579f5d91",
        "type": "DT_Plate",
        "objects": [
            "53502573-a985-4198-a5b6-69db476cc755"
        ]
    }


  • statistics

    Code Block
    "statistics": {
        "point": "archive_usage",
        "item": "hosts/Server1/MultimediaStorage.AntiqueWhite/MultimediaStorage",
        "value": 100,
        "delta": 0,
        "trend": "ET_RISING"
    }


...