| 1 | plugin_name: python.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: python.d.plugin |
| 5 | module_name: am2320 |
| 6 | monitored_instance: |
| 7 | name: AM2320 |
| 8 | link: 'https://learn.adafruit.com/adafruit-am2320-temperature-humidity-i2c-sensor/overview' |
| 9 | categories: |
| 10 | - data-collection.hardware-and-sensors |
| 11 | icon_filename: 'microchip.svg' |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: '' |
| 17 | keywords: |
| 18 | - temperature |
| 19 | - am2320 |
| 20 | - sensor |
| 21 | - humidity |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: 'This collector monitors AM2320 sensor metrics about temperature and humidity.' |
| 25 | method_description: 'It retrieves temperature and humidity values by contacting an AM2320 sensor over i2c.' |
| 26 | supported_platforms: |
| 27 | include: [] |
| 28 | exclude: [] |
| 29 | multi_instance: false |
| 30 | additional_permissions: |
| 31 | description: '' |
| 32 | default_behavior: |
| 33 | auto_detection: |
| 34 | description: 'Assuming prerequisites are met, the collector will try to connect to the sensor via i2c' |
| 35 | limits: |
| 36 | description: '' |
| 37 | performance_impact: |
| 38 | description: '' |
| 39 | setup: |
| 40 | prerequisites: |
| 41 | list: |
| 42 | - title: 'Sensor connection to a Raspberry Pi' |
| 43 | description: | |
| 44 | Connect the am2320 to the Raspberry Pi I2C pins |
| 45 | |
| 46 | Raspberry Pi 3B/4 Pins: |
| 47 | |
| 48 | - Board 3.3V (pin 1) to sensor VIN (pin 1) |
| 49 | - Board SDA (pin 3) to sensor SDA (pin 2) |
| 50 | - Board GND (pin 6) to sensor GND (pin 3) |
| 51 | - Board SCL (pin 5) to sensor SCL (pin 4) |
| 52 | |
| 53 | You may also need to add two I2C pullup resistors if your board does not already have them. The Raspberry Pi does have internal pullup resistors but it doesn't hurt to add them anyway. You can use 2.2K - 10K but we will just use 10K. The resistors go from VDD to SCL and SDA each. |
| 54 | - title: 'Software requirements' |
| 55 | description: | |
| 56 | Install the Adafruit Circuit Python AM2320 library: |
| 57 | |
| 58 | `sudo pip3 install adafruit-circuitpython-am2320` |
| 59 | configuration: |
| 60 | file: |
| 61 | name: python.d/am2320.conf |
| 62 | options: |
| 63 | description: | |
| 64 | There are 2 sections: |
| 65 | |
| 66 | * Global variables |
| 67 | * One or more JOBS that can define multiple different instances to monitor. |
| 68 | |
| 69 | The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values. |
| 70 | |
| 71 | Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition. |
| 72 | |
| 73 | Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified. |
| 74 | folding: |
| 75 | title: "Config options" |
| 76 | enabled: true |
| 77 | list: |
| 78 | - name: update_every |
| 79 | description: Sets the default data collection frequency. |
| 80 | default_value: 5 |
| 81 | required: false |
| 82 | - name: priority |
| 83 | description: Controls the order of charts at the netdata dashboard. |
| 84 | default_value: 60000 |
| 85 | required: false |
| 86 | - name: autodetection_retry |
| 87 | description: Sets the job re-check interval in seconds. |
| 88 | default_value: 0 |
| 89 | required: false |
| 90 | - name: penalty |
| 91 | description: Indicates whether to apply penalty to update_every in case of failures. |
| 92 | default_value: yes |
| 93 | required: false |
| 94 | - name: name |
| 95 | description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works. |
| 96 | default_value: '' |
| 97 | required: false |
| 98 | examples: |
| 99 | folding: |
| 100 | enabled: false |
| 101 | title: "Config" |
| 102 | list: |
| 103 | - name: Local sensor |
| 104 | description: A basic JOB configuration |
| 105 | config: | |
| 106 | local_sensor: |
| 107 | name: 'Local AM2320' |
| 108 | troubleshooting: |
| 109 | problems: |
| 110 | list: [] |
| 111 | alerts: [] |
| 112 | metrics: |
| 113 | folding: |
| 114 | title: Metrics |
| 115 | enabled: false |
| 116 | description: "" |
| 117 | availability: [] |
| 118 | scopes: |
| 119 | - name: global |
| 120 | description: "These metrics refer to the entire monitored application." |
| 121 | labels: [] |
| 122 | metrics: |
| 123 | - name: am2320.temperature |
| 124 | description: Temperature |
| 125 | unit: "celsius" |
| 126 | chart_type: line |
| 127 | dimensions: |
| 128 | - name: temperature |
| 129 | - name: am2320.humidity |
| 130 | description: Relative Humidity |
| 131 | unit: "percentage" |
| 132 | chart_type: line |
| 133 | dimensions: |
| 134 | - name: humidity |