The Camio C-Cure Gateway communicates with C-Cure server v2.9 and above using the Victor Web Service.
This Camio User Guide covers:
Overview of Camio with C-Cure
Fast visual verification and tailgating detection
Camio enables fast search and alerts on events like tailgating and entry unlocked. Read more at https://camio.com/tailgating.
(NOTE: temporarily, only tailgating and entry unlocked are supported in this C-Cure integration)
Camio counts the number of people that pass through the door to compare that number to the actual number of C-Cure access granted events. If those counts don't match, then the video is annotated with "tailgating" unauthorized access. This video illustrates tailgating detection as the floor plane tiles turn red when the second person enters after only one access granted event:
Works with existing cameras
Setup takes less than 15 minutes. Each camera is mapped to the C-Cure reader so that events from those readers annotate the video from that camera. You configure the on-premise C-Cure Gateway with the credentials required to subscribe to C-Cure access control events.
Mapping cameras to C-Cure readers
The first step is to associate your C-Cure readers with any cameras that can see the doors controlled by those readers.
- Generate your Camio Authorization token to be used by the C-Cure Gateway to annotate video with incoming access control events.
- Sign-in as the Camio account manager and press the Generate button at https://camio.com/settings/integrations/pacs
- Copy the token immediately after you generate it, since you will not be able to retrieve it again later.
- Paste the token into your camio_config.yaml as camio_auth_token: {{CAMIO_AUTH_TOKEN_HERE}} value.
- Find your C-Cure server, database, and user credentials and place them in the associated fields within the ccure_config.yaml and the ccure_user.yaml files.
- Select the C-Cure Reader from the dropdown list next to each camera that has a view of the people entering the door associated with that reader and press Save.
Camio Setup for C-Cure
The C-Cure Gateway subscribes to C-Cure access control events in order to annotate the video associated with each event.
C-Cure Gateway Installation
The Camio Gateway runs as a Kubernetes deployment installable with Helm, which can run on any host machine (e.g. Linux, Windows) that can access the C-Cure server. If your firewall restricts the sites contacted, then please see firewall rules.
Quick Install via Helm
Detailed instructions for installing any of our PACS Gateway deployments through Helm can be found at our Camio User Guide for setup and deployment of Camio PACS Gateways. The following instructions will be a brief overview of setting up with Helm, specific to the Camio C-Cure Gateway.
1. Create your values.yaml file. The most basic values.yaml for the gateway should look like:
ccure:
user:
username: "INSERT USERNAME HERE"
password: "INSERT PASSWORD HERE"
client_name: "INSERT CLIENT NAME HERE"
token: "INSERT TOKEN HERE"
config:
server_name_or_ip: "INSERT C-CURE.SERVER.DOMAIN OR IP HERE"
camio:
camio_auth_token: "INSERT AUTH TOKEN HERE"
The client_name is the client name used to connect the C-Cure victor web service, and can be found in your license as Company Name.
The token is the client ID, which is the application’s license GUID in string format (eg. 9555e526-d03f-4ae6-b39a-01b18323d1bc). It can be found in the Tyco\CrossFire\Tools folder called InsertLicenseOption, as an exe or bat file.
The server_name_or_ip is the domain or IP address that your victor web service is accessible on.
If you use a C-Cure version below 2.9, you will also need to add the version field under the C-Cure config section like so:
ccure:
user:
...
config:
server_name_or_ip: "INSERT C-CURE.SERVER.DOMAIN OR IP HERE"
version: "YOUR.VERSION"
The following are all the supported fields, including defaults:
ccure:
user:
username: "INSERT USERNAME HERE"
password: "INSERT PASSWORD HERE"
client_name: "INSERT CLIENT NAME HERE"
token: "INSERT TOKEN HERE"
config:
server_name_or_ip: "INSERT C-CURE.SERVER.DOMAIN OR IP HERE"
version: "2.90"
camio:
stats_report_time_interval: 60
camio_endpoint_events: "https://camio.com/api/integrations/pacs/webhooks"
camio_endpoint_stats: "https://camio.com/api/integrations/pacs/stats"
camio_endpoint_log: "https://camio.com/api/integrations/pacs/logs"
camio_endpoint_devices: "https://camio.com/api/integrations/pacs/devices"
camio_auth_token: "INSERT AUTH TOKEN HERE"
camio_max_retries: 100
camio_send_queue_data_interval: 20
advanced:
query_filter: '["SoftwareHouse.NextGen.Common.LogMessageFormats.CardAdmitted"]'
# Uncomment any settings where default values shown need to be modified
# (default values should work for most deployments, except where the OpenAccess port number was changed)
# log_level: INFO
# stats_report_time_interval: 60
# send_chunk_time_interval: 10
# total_session_time_interval: 150
# request_attempts_before_timeout: 4
# poll_readers_interval: 120
container:
image: gcr.io/camiologger/camio-ccure:v1.1.4
The current version of the Camio C-Cure Gateway does not support self-signed certificates. Please contact support@camio.com for more details if your deployment will need to use self-signed certificates.
2. Create your K8s cluster if does not exist
3. Run the following command, including the proper path to your values file following the -f flag:
helm install camio-ccure oci://us-central1-docker.pkg.dev/camiologger/helm/camio-ccure --version 1.1.0 -f /PATH/TO/values.yaml [-n camio] [--create-namespace]
The namespace ( -n ) argument is optional and will deploy the gateway in the specified namespace. If not included, the gateway will be set up in the default namespace. Use --create-namespace if the namespace you want to use does not currently exist.
4. Confirm that your helm installation was successful by running:
kubectl get pods [-n camio]
The output should look something like:
NAME READY STATUS RESTARTS AGE
ccure-XXXXXXXXX-XXXXX 1/1 Running 0 9s
If the ccure pod shows as 1/1 READY and 0 RESTARTS, it is probably running correctly. If you would like more details, you can retrieve the logs for your pod by running:
kubectl logs ccure-XXXXXXXXX-XXXXX [-n camio]
C-Cure Event Filter
Descriptions:
- Entry Unlocked
- CardAdmitted
- Entry Ajar
- (None Currently)
- Entry Forced
- ObjectChangedState
- Unmapped But Still Labeled:
- Doubleswipe
- OperatorLogin
- DeviceError
- CardRejected
- ManualAction
- TemporaryCredential
- IntrusionZoneActivity
- SystemError
- KeypadCommandActivity
- Allowed
- Accessed
- Pre Held
- Access Denied
- Wrong PIN
- Unknown Event
- IP Camera Offline
- IP Camera Online
- Camera Restarted
- Tailgating
C-Cure Gateway Host Hardware Requirements
The CPU and RAM required of the host machine that runs the C-Cure Gateway Docker containers varies with the maximum throughput of access control events. This guide covers common volumes:
Max Event Rate |
CPU Cores |
RAM |
100 events/second |
1 |
300 MiB |
1,000 events/second |
2 |
400 MiB |
10,000 events/second |
2 |
400 MiB |
If you are also setting up MicroK8s on your machine, MicroK8s recommends 20G disk space and 4G of memory.
Firewall Rules
During the initial setup and any updates to the deployment, you will need access to these domains:
- us-central1-docker.pkg.dev
During operation, the Camio C-Cure Gateway will need access to these servers:
- https://camio.com/api/integrations/pacs/webhooks
- https://camio.com/api/integrations/pacs/devices
- https://camio.com/api/integrations/pacs/stats
- https://camio.com/api/integrations/pacs/logs
Note: These rules only cover the Camio Gateway. If you are setting up K8s for the first time you may need to set up additional firewall rules.
Ports
The Camio C-Cure Gateway uses ports:
- 443 to talk to the Internet servers above
- Whichever port specified in the C-Cure server domain or IP to talk to the C-Cure server
During operation, the Camio C-Cure Gateway uses two pods that talk to each other using ports 6379 and 8080. But those ports aren't open on the Local Area Network.
The port used to make requests of the C-Cure server will vary based on your network settings of your C-Cure system, but the default port found in C-Cure_config.yaml is 22.
----
For more information on PACS integrations see https://help.camio.com/hc/en-us/articles/4409969059732-How-do-I-set-up-a-Physical-Access-Control-System-integration-User-s-Guide- and https://help.camio.com/hc/en-us/articles/4409631039892-How-do-I-create-a-Physical-Access-Control-System-integration-Developer-s-Guide-
Comments