konrad
/
1-wire-temp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add README

This commit is contained in:
kolaente 2021-10-02 13:47:47 +02:00
parent b204e39740
commit 5f819c467b
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,2 +1,2 @@
.idea/
1-wire-temp
1-wire-temp*

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# 1-wire temperature metrics with prometheus
This is a simple package providing the temperature of a 1-wire sensor such as the DH1820 as prometheus metrics. It reads
the `w1_slave` file at `/sys/bus/w1/devices/<sensor>`, parses it and provides the read temperature at a webserver
running on port 2112 at `/metrics`.
## Usage
Simply run the compiled program and provide the id of the sensor with the `-s` flag. The id is the name of the folder at
`/sys/bus/w1/devices/` containing the `w1_slave` file.
## Building
To build this package for the raspberry pi zero:
```bash
GOOS=linux GOARCH=arm GOARM=6 go build -o 1-wire-temp-arm
```
To build for all other Pi's:
```bash
GOOS=linux GOARCH=arm GOARM=7 go build -o 1-wire-temp-arm
```