Data tagged a senstive in logs and diagnostic

[thewade]

How does the sensitive option work?

I have the following in my yaml file to not include my location in diagnostic files:

  - entity: number
    name: Latitude
    category: config
    icon: "mdi:latitude"
    dps:
      - id: 143
        type: integer
        name: value
        sensitive: true
        range:
          min: -900000
          max: 900000
        mapping:
          - scale: 10000
  - entity: number
    name: Longitude
    category: config
    icon: "mdi:longitude"
    dps:
      - id: 142
        type: integer
        name: value
        sensitive: true
        range:
          min: -1800000
          max: 1800000
        mapping:
          - scale: 10000

However when I click Download Diagnostics I still see it.

(I have replaced the actual number with X's in the example)

  
  "data": {
    "name": "Smart Planter",
    "type": "plantsio_ivy_smart_planter",
    "device_id": "**REDACTED**",
    "device_cid": "",
    "local_key": "**REDACTED**",
    "host": "**REDACTED**",
    "protocol_version": 3.4,
    "tinytuya_version": "1.15.1",
    "api_version_set": 3.4,
    "api_version_used": 3.4,
    "api_working": true,
    "status": {},
    "cached_state": {
      "updated_at": 1732469992.2060227,
      "101": 0,
      "102": true,
      "103": 12,
      "104": 220,
      "105": 36,
      "106": 2,
      "107": "{\"hd_ver\":20230410,\"ip\":\"192.168.0.14\",\"media_ver\":1692933546}",
      "108": 15,
      "109": true,
      "110": true,
      "111": "no_touch",
      "113": 0,
      "115": 80,
      "116": 80,
      "117": 0,
      "119": 36,
      "121": 100,
      "122": 100,
      "123": true,
      "124": false,
      "125": true,
      "126": 0,
      "127": false,
      "128": false,
      "129": true,
      "130": false,
      "131": true,
      "132": true,
      "133": 1320,
      "134": 540,
      "135": false,
      "136": false,
      "138": 5,
      "139": 1,
      "140": 1,
      "141": true,
      "142": -XXXXXX,
      "143": XXXXXX,
      "144": 1,
      "145": 25,
      "146": 100,
      "147": 100,
      "148": 36,
      "149": 220,
      "150": 15,
      "151": 3,
      "152": 1720274960
    },


    {
      "disabled": false,
      "disabled_by": null,
      "entity_category": "config",
      "device_class": null,
      "original_device_class": null,
      "icon": null,
      "unit_of_measurement": null,
      "state": {
        "entity_id": "number.smart_planter_latitude",
        "state": "XX.XX",
        "attributes": {
          "min": -90.0,
          "max": 90.0,
          "step": 0.0001,
          "mode": "auto",
          "icon": "mdi:latitude",
          "friendly_name": "Smart Planter Latitude"
        },
        "last_changed": "2024-11-24T17:39:51.180763+00:00",
        "last_reported": "2024-11-24T17:39:52.214636+00:00",
        "last_updated": "2024-11-24T17:39:51.180763+00:00"
      }
    },
    {
      "disabled": false,
      "disabled_by": null,
      "entity_category": "config",
      "device_class": null,
      "original_device_class": null,
      "icon": null,
      "unit_of_measurement": null,
      "state": {
        "entity_id": "number.smart_planter_longitude",
        "state": "-XX.XX",
        "attributes": {
          "min": -180.0,
          "max": 180.0,
          "step": 0.0001,
          "mode": "auto",
          "icon": "mdi:longitude",
          "friendly_name": "Smart Planter Longitude"
        },
        "last_changed": "2024-11-24T17:14:36.438827+00:00",
        "last_reported": "2024-11-24T17:39:52.215662+00:00",
        "last_updated": "2024-11-24T17:14:36.438827+00:00"
      }
    },

It also shows in the debug logs for the received DPS and mapping output:

2024-11-24 12:41:26.844 DEBUG (MainThread) [custom_components.tuya_local.device] Smart Planter received {"101": 0, "102": true, "103": 12, "104": 220, "105": 36, "106": 2, "107": "{\"hd_ver\":20230410,\"ip\":\"192.168.0.14\",\"media_ver\":1692933546}", "108": 15, "109": true, "110": true, "111": "no_touch", "113": 0, "115": 80, "116": 80, "117": 0, "119": 36, "121": 100, "122": 100, "123": true, "124": false, "125": true, "126": 0, "127": false, "128": false, "129": true, "130": false, "131": true, "132": true, "133": 1320, "134": 540, "135": false, "136": false, "138": 5, "139": 1, "140": 1, "141": true, "142": -XXXXX, "143": XXXXXX, "144": 1, "145": 25, "146": 100, "147": 100, "148": 36, "149": 220, "150": 15, "151": 3, "152": 1720274960, "full_poll": true}
2024-11-24 12:41:26.853 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Considering mapping for range of value
2024-11-24 12:41:26.854 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Considering mapping for range of value
2024-11-24 12:41:26.854 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Considering mapping for step of value
2024-11-24 12:41:26.854 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Step for value is 1 with scale 10000
2024-11-24 12:41:26.855 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Smart Planter: Mapped dps 143 value from XXXXX to XX.XX
2024-11-24 12:41:26.855 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Smart Planter: Mapped dps 143 value from XXXXX to XX.XX
2024-11-24 12:41:26.855 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Considering mapping for range of value
2024-11-24 12:41:26.856 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Considering mapping for range of value
2024-11-24 12:41:26.856 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Considering mapping for step of value
2024-11-24 12:41:26.856 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Step for value is 1 with scale 10000
2024-11-24 12:41:26.856 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Smart Planter: Mapped dps 142 value from -XXXXXX to -XX.XX
2024-11-24 12:41:26.857 DEBUG (MainThread) [custom_components.tuya_local.helpers.device_config] Smart Planter: Mapped dps 142 value from -XXXXXX to -XX.XX

[make-all]

Did you restart HA after making this change? Logs are not expected to be redacted, as some will be outside of the integration's control.

[thewade]

After restarting I didn't notice any change in Download Diagnostics output. I still see the cached data-point values under data.cached_state and the home assistant entities under data.home_assistant.entities.state.

I am running 2024.11.4 with the updated yaml your pushed for the device.

[make-all]

I found the issue.

sensitive = []

sensitive += "143"

The above was expected to add the value "143" to the sensitive list. But actually it adds '1', '4', '3', so the result is that different dps than expected get redacted (all single digit dp ids).