Go to file
CSRBot f7ba60ed59
continuous-integration/drone/pr Build is passing Details
continuous-integration/drone/push Build is passing Details
chore(deps): update module github.com/spf13/cobra to v1.8.1
2024-06-14 22:08:48 +00:00
cli fix: golangci-lint and gosec warnings 2021-05-26 19:47:15 +02:00
pkg test(ci): start postgres db as drone service 2022-03-18 18:37:53 +01:00
systemd fix: systemd service unit 2020-08-19 19:15:06 +02:00
.dockerignore fix(Makefile, Dockerfile): optimization of the container image building process 2020-01-09 21:59:18 +01:00
.drone.yml chore(deps): update docker.io/library/golang docker tag to v1.22.4 2024-06-04 22:07:45 +00:00
.editorconfig fix: renamed project 2019-04-18 16:59:55 +02:00
.gitattributes fix: renamed project 2019-04-18 16:59:55 +02:00
.gitignore fix: Makefile 2021-05-26 19:57:47 +02:00
.golangci.yml fix: golangci-lint and gosec warnings 2021-05-26 19:47:15 +02:00
.markdownlint.yaml fix: add markdownlint config 2022-03-16 20:18:24 +01:00
Dockerfile fix: adapt go proxy settings 2021-04-09 17:11:51 +02:00
LICENSE fix(LICENSE): publish flucky under the apache 2.0 license 2019-08-25 16:32:20 +02:00
Makefile fix: Makefile 2021-05-26 19:57:47 +02:00
README.md fix: markdown capitalization error 2022-03-16 20:23:26 +01:00
docker-compose.yml chore(deps): update docker.io/library/postgres docker tag to v16.2 2024-02-13 02:05:55 +00:00
go.mod chore(deps): update module github.com/spf13/cobra to v1.8.1 2024-06-14 22:08:48 +00:00
go.sum chore(deps): update module github.com/spf13/cobra to v1.8.1 2024-06-14 22:08:48 +00:00
main.go fix: golangci-lint and gosec warnings 2021-05-26 19:47:15 +02:00
renovate.json fix(renovate): remove automerge options 2024-01-21 15:01:44 +01:00

README.md

flucky

Build Status Docker Pulls

flucky is a lightweight program written in go for reading data from sensors, for example with a banana or raspberry pi. In addition, flucky provides a REST-API to receive from other flucky installations measured values. All received measured values, no matter if they come directly from flucky or from a server instance of flucky with the provided REST-API, can be stored into a database.

Supported and planned sensors

Name Measured values Supported
BME280 humidity, pressure, temperature Yes
DHT11 temperature Yes
DHT22 temperature Yes
DS18B20 temperature Yes
SDS011 fine dust Planning

Supported and planned backends

Backend Supported
flucky WIP
Logfile CSV, JSON, XML
MySQL, MariaDB Planning
PostgreSQL Yes
SQLite Planning

Installation

flucky can be installed over multiple ways. For example over a specific linux distributions package or as container. The following table lists all repositories where flucky can be otained from, but flucky can already be compiled from source code.

Distribution Repo's
Arch Linux armv7, x86_64
Debian, Ubuntu, Linux Mint Currently not supported
RHEL, Fedora, Centos Planning
Container Image hub.docker.com

Compiling the source code

An additional ways to install flucky is to compile the source code. There are two different ways to compile flucky from scratch. The easier ways is to use the pre-defined container image, which has included all dependencies to compile flucky. Alternatively, if all dependencies are met, flucky can also be compiled without the container image. Both variants are briefly described.

Compiling the source code via container image

To compile flucky via container image it's necessary, that a container runtime is installed. In the Makefile is predefined docker, but it's can be also used podman. Execute make container-run/flucky to start the compiling process.

$ make container-run/flucky
make container-run COMMAND=flucky
make[1]: Directory „/home/markus/workspace/flucky“ is entered
/usr/bin/docker run \
        --rm \
        --volume /home/markus/workspace/flucky:/workspace \
        volkerraschek/build-image:latest \
                make go-build \
                        VERSION=60ee044-git \
                        GOOS=linux \
                        GOARCH=amd64
go-bindata -pkg db -o ./pkg/db/bindataSQL.go ./pkg/db/sql/***
go-bindata -pkg goldenfiles -o ./test/goldenfiles/bindata.go ./test/goldenfiles/json/***
GOOS=linux \
GOARCH=amd64 \
        go build -ldflags "-X main.version=60ee044-git"
go: finding github.com/spf13/pflag v1.0.3
go: finding github.com/satori/go.uuid v1.2.0
...

Compiling the source code without container image

Make sure you have installed go >= v1.12. Execute make flucky to compile flucky without a container-image. There should be a similar output as when compiling flucky via the container image.