Add ISAPI support for SupplementLight / ColorVu white light mode control #118

Activity

1. GwiezdnySzeryf commented on Jun 3, 2026

   

   GwiezdnySzeryf

   on Jun 3, 2026

   Author

   More actions

   I successfully implemented this locally in Home Assistant as a working setup:

   • input_select.camera_supplement_light_mode (helper, options: eventIntelligence, colorVuWhiteLight, irLight, close)
   • rest_command.hikvision_set_supplement_light_mode with PUT /ISAPI/Image/channels/1/supplementLight (digest auth, minimal XML body)
   • script.set_camera_supplement_light_mode calling the rest_command
   • automation.set_camera_light_mode_on_change triggered by state change of the helper

   All ISAPI endpoints used (GET/PUT supplementLight, GET capabilities) work correctly on:

   Model: IPC-T260HA-LU Black
   Firmware: V5.8.5 build 250714
   

   The rest_command PUT test with the current mode (eventIntelligence) returned statusCode 1 / OK, and the camera state was confirmed unchanged via GET.
2. mezz64 commented on Sep 1, 2026

   

   mezz64

   on Sep 1, 2026

   Owner

   More actions

   I successfully implemented this locally in Home Assistant as a working setup:

   * `input_select.camera_supplement_light_mode` (helper, options: `eventIntelligence`, `colorVuWhiteLight`, `irLight`, `close`)
   
   * `rest_command.hikvision_set_supplement_light_mode` with `PUT /ISAPI/Image/channels/1/supplementLight` (digest auth, minimal XML body)
   
   * `script.set_camera_supplement_light_mode` calling the rest_command
   
   * `automation.set_camera_light_mode_on_change` triggered by state change of the helper
   

   All ISAPI endpoints used (GET/PUT supplementLight, GET capabilities) work correctly on:

   Model: IPC-T260HA-LU Black
   Firmware: V5.8.5 build 250714
   

   The rest_command PUT test with the current mode (eventIntelligence) returned statusCode 1 / OK, and the camera state was confirmed unchanged via GET.

   Are you modifying the ISAPI capability recently added into the library or other adjustments? I always welcome PR's and am open to adding additional endpoints to the existing ISAPI code.
3. mezz64 commented on Nov 12, 2026

   

   mezz64

   on Nov 12, 2026

   Last edited by mezz64

   Owner

   More actions

   pyHik's master branch now has a general image-settings API (ISAPIClient.get_image_settings and set_image_setting, added in #142 and #143). It isn't released yet. It reads /ISAPI/Image/channels/<n>/capabilities and returns each setting the camera reports as a switch, number or select. So if your camera lists SupplementLight there, the light mode should appear as the select SupplementLight/supplementLightMode, without needing dedicated methods. The brightness values should appear as numbers.

   It hasn't been tested on a ColorVu camera yet, so if you have time I'd be interested to know whether it works on your IPC-T260HA-LU. One difference from your rest_command: pyHik writes by reading the whole document from /ISAPI/Image/channels/1, changing only the one value, and sending the document back, not by writing to /supplementLight. I don't know yet whether your camera accepts that.

   To install from master:

   pip install git+https://github.com/mezz64/pyHik.git

   Then:

   from pyhik.isapi import ISAPIClient
   
   with ISAPIClient("CAMERA_IP", port=80, username="USER", password="PASS") as client:
       for s in client.get_image_settings(1):
           if s.path.startswith("SupplementLight"):
               print(s.path, s.type.value, s.value, s.options or (s.min_value, s.max_value))
   
       path = "SupplementLight/supplementLightMode"
       original = client.get_image_values(1).get(path)
       print("current mode:", original)
   
       result = client.set_image_setting(path, "colorVuWhiteLight", 1)
       print("write:", result)
       print("read back:", client.get_image_values(1).get(path))
   
       print("restore:", client.set_image_setting(path, original, 1))

   This changes the light mode briefly and then puts it back.

   It would help to see:

   • the output of the script;
   • if the write fails, the sub_status it reports (for example notSupport or badXmlFormat).

   On the Home Assistant side, the integration doesn't use these settings yet. A select entity would come later in a separate HA change.