\r \r

Hik-Connect Team Skills\r

\r

1. Introduction\r

Hik-Connect_Team_Skills is a full-featured integration Skills designed specifically for Hik-Connect for Teams (HCT) developers. Based on the HCTOpen OpenAPI system, it encapsulates core capabilities from basic resource management to advanced alarm push through Python scripts.\r \r This Skills adopts a modular design with built-in automated Token maintenance mechanisms, dynamic path searching, and standardized error handling, aiming to help developers quickly build HCT-based automated O&M, security monitoring, and business integration systems.\r \r ---\r \r

2. Core Modules Deep Dive\r

\r This Skills consists of five core sub-modules, each providing deep support for specific business scenarios:\r \r | Module Name | Core Functions | Core Scripts | Applicable Scenarios |\r |:---------------------------------------------------------------------------|:----------------------------------------------------------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|\r | 📦 Resource Management | Device discovery, detail acquisition, channel enumeration | list_devices.py\x3Cbr>device_detail.py\x3Cbr>device_channels.py\x3Cbr>list_doors.py | Asset inventory, obtaining device serial numbers and channel IDs, access control resources, synchronizing organizational structure resources. |\r | 🚪 Access Control (ACS) | Remote open/close, normally open/normally closed control | acs_control.py | Remote office collaboration, unattended entrance management, access control linkage in emergencies. |\r | 📸 Device Capture | Real-time trigger capture, obtain image URL | capture_pic.py | Anomaly verification, real-time screen preview, manual secondary verification of AI recognition results. |\r | 🎥 Video Streaming | Obtain real-time video stream | get_video_url.py | Real-time monitoring embedding, remote video inspection, third-party monitoring large screen integration. |\r | 🔔 Alarm Push (Alarm) | Webhook subscription, fine-grained event management | webhook_manager.py\x3Cbr>event_manager.py | Real-time alarm notification, third-party system integration (e.g., Feishu/DingTalk robots). |\r \r ---\r \r

3. Environment Preparation and Global Configuration\r

\r

3.1 Credential Configuration\r

\r Before using any module, credentials must be configured. The system supports two methods:\r \r

Method A: Environment Variables (Recommended)\r

\r

# Required: Obtain from Hik-Connect HCT Developer Platform\r
export HIK_CONNECT_TEAM_OPENAPI_APP_KEY="Your Hik-Connect Team OpenAPI AppKey"\r
export HIK_CONNECT_TEAM_OPENAPI_SECRET_KEY="Your Hik-Connect Team OpenAPI SecretKey"\r
# Note: API domain is automatically obtained from token response (no longer required)\r
\r
# Optional: Token cache configuration (enabled by default to reduce API call frequency)\r
export HIK_CONNECT_TEAM_TOKEN_CACHE="1"  # 1=Enabled, 0=Disabled\r
```\r
\r
#### Method B: OpenClaw Config Files (Fallback)\r
\r
If environment variables are not set, the system will automatically search for credentials in OpenClaw config files:\r
\r
```\r
Config search order (first found wins):\r
1. ~/.openclaw/config.json\r
2. ~/.openclaw/gateway/config.json\r
3. ~/.openclaw/channels.json\r
```\r
\r
Config format:\r
```json\r
{\r
  "channels": {\r
    "hik_connect_team_openapi": {\r
      "appKey": "Your Hik-Connect Team OpenAPI AppKey",\r
      "secretKey": "Your Hik-Connect Team OpenAPI SecretKey",\r
      "enabled": true\r
    }\r
  }\r
}\r
```\r
\r
**Recommended: Save to `~/.openclaw/channels.json`** — This is the dedicated file for channel credentials.\r
\r
**⚠️ Security Note**: Storing credentials in config files is convenient but introduces some risk. Environment variables are recommended for better security.\r
\r
\r
### 3.2 Dependency Installation\r
This Skills is developed based on Python 3.8+. It is recommended to install necessary dependencies using the following command:\r
```bash\r
pip3 install requests tabulate pycryptodome Pillow\r
```\r
\r
---\r
\r
## 🔒 Config File Reading Details\r
\r
**Credential Priority** (Highest to Lowest):\r
\r
```\r
┌─────────────────────────────────────────────────────────────┐\r
│ 1. Environment Variables (Highest Priority - Recommended)    │\r
│    ├─ HIK_CONNECT_TEAM_OPENAPI_APP_KEY                              │\r
│    └─ HIK_CONNECT_TEAM_OPENAPI_SECRET_KEY                           │\r
│    ✅ Advantage: No config file reading, fully isolated    │\r
├─────────────────────────────────────────────────────────────┤\r
│ 2. OpenClaw Config Files (Only when env vars not set)        │\r
│    ├─ ~/.openclaw/config.json                               │\r
│    ├─ ~/.openclaw/gateway/config.json                       │\r
│    └─ ~/.openclaw/channels.json                             │\r
│    ⚠️ Note: Only reads channels.hik_connect_team_openapi field    │\r
├─────────────────────────────────────────────────────────────┤\r
```\r
\r
## 4. Directory Structure Description\r
```text\r
Hik-Connect_Team_Skills/\r
├── SKILL.md                # This guide file (Full-featured integration guide)\r
├── lib/                    # Core library\r
│   └── token_manager.py    # Encapsulates HCTOpenClient base class, handles Token refresh, request retries, and path searching\r
└── modules/                # Functional sub-modules\r
    ├── Hik-Connect_Team_Resource/  # Resource Management: Devices, channels, details\r
    ├── Hik-Connect_Team_ACS/       # Access Control: Open/close, normally open/normally closed\r
    ├── Hik-Connect_Team_Capture/   # Device Capture: Real-time trigger, URL acquisition\r
    ├── Hik-Connect_Team_Video/     # Video Streaming: Real-time preview address acquisition\r
    └── Hik-Connect_Team_Alarm/     # Alarm Push: Webhook management, event subscription\r
```\r
\r
---\r
\r
## 5. Security and Best Practices\r
\r
1.  **Token Security**: The Skills automatically caches Tokens locally. Please ensure the security of the running environment to prevent unauthorized reading of cache files in the `lib/` directory.\r
2.  **HTTPS Mandatory Requirement**: All Webhook callbacks from the HCT platform must use HTTPS. It is recommended to use `ngrok` or `cpolar` with SSL certificates for secure access.\r
3.  **Signature Verification**: In the Alarm module, be sure to configure `signSecret` and implement HMAC-SHA256 signature verification on your receiving end to prevent forged alarm pushes.\r
4.  **Error Handling**: All scripts return standard JSON format. If `success` is `false`, please check the `message` field for detailed error reasons.\r
\r
---\r