| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: go.d.plugin |
| 5 | module_name: w1sensor |
| 6 | monitored_instance: |
| 7 | name: 1-Wire Sensors |
| 8 | link: "https://www.analog.com/en/product-category/1wire-temperature-sensors.html" |
| 9 | categories: |
| 10 | - data-collection.hardware-and-sensors |
| 11 | icon_filename: "1-wire.png" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: |
| 18 | - temperature |
| 19 | - sensor |
| 20 | - 1-wire |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | Monitor 1-Wire Sensors metrics with Netdata for optimal environmental conditions monitoring. Enhance your environmental monitoring with real-time insights and alerts. |
| 25 | method_description: The collector uses the wire, w1_gpio, and w1_therm kernel modules. Currently temperature sensors are supported and automatically detected. |
| 26 | supported_platforms: |
| 27 | include: |
| 28 | - Linux |
| 29 | exclude: [] |
| 30 | multi_instance: true |
| 31 | additional_permissions: |
| 32 | description: "" |
| 33 | default_behavior: |
| 34 | auto_detection: |
| 35 | description: "The collector will try to auto detect available 1-Wire devices." |
| 36 | limits: |
| 37 | description: "" |
| 38 | performance_impact: |
| 39 | description: "" |
| 40 | setup: |
| 41 | prerequisites: |
| 42 | list: |
| 43 | - title: "Required Linux kernel modules" |
| 44 | description: "Make sure `wire`, `w1_gpio`, and `w1_therm` kernel modules are loaded." |
| 45 | configuration: |
| 46 | file: |
| 47 | name: go.d/w1sensor.conf |
| 48 | options: |
| 49 | description: | |
| 50 | The following options can be defined globally: update_every. |
| 51 | folding: |
| 52 | title: Config options |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update_every |
| 56 | description: Data collection frequency. |
| 57 | default_value: 1 |
| 58 | required: false |
| 59 | - name: sensors_path |
| 60 | description: Directory path containing sensor folders with w1_slave files. |
| 61 | default_value: /sys/bus/w1/devices |
| 62 | required: false |
| 63 | examples: |
| 64 | folding: |
| 65 | title: "" |
| 66 | enabled: false |
| 67 | list: |
| 68 | - name: Custom sensor device path |
| 69 | description: Monitors a virtual sensor when the w1_slave file is located in a custom directory instead of the default location. |
| 70 | config: | |
| 71 | jobs: |
| 72 | - name: custom_sensors_path |
| 73 | sensors_path: /custom/path/devices |
| 74 | troubleshooting: |
| 75 | problems: |
| 76 | list: [] |
| 77 | alerts: [] |
| 78 | metrics: |
| 79 | folding: |
| 80 | title: Metrics |
| 81 | enabled: false |
| 82 | description: "" |
| 83 | availability: [] |
| 84 | scopes: |
| 85 | - name: sensor |
| 86 | description: These metrics refer to the 1-Wire Sensor. |
| 87 | labels: [] |
| 88 | metrics: |
| 89 | - name: w1sensor.temperature |
| 90 | description: 1-Wire Temperature Sensor |
| 91 | unit: "Celsius" |
| 92 | chart_type: line |
| 93 | dimensions: |
| 94 | - name: temperature |