konsum

konsum

Collect resource usage in a home environment.

run

konsum --config=<<some dir>> start

konsum --config=<<some dir>> list [category]

konsum --config=<<some dir>> insert category value [time]

konsum --config=<<some dir>> backup [file]

konsum --config=<<some dir>> restore [file]

install

npm -g install konsum

how to configure

create self signed cert

openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes

JWT

token setup

openssl genrsa -out demo.rsa 1024
openssl rsa -in demo.rsa -pubout > demo.rsa.pub

test with:

curl -H "Content-Type: application/json" \
     -d '{"username":"admin","password":"start123"}' \
     -X POST http://localhost:12345/authenticate

and exec a request

TOKEN=...
CATEGORY=...
curl -H "Authorization: Bearer $TOKEN" \
     http://localhost:12345/category/$CATEGORY/value

TOKEN=...
CATEGORY=...
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"value":"1234.5","time":"1995-12-17T03:24:00"}' \
     http://localhost:12345/category/$CATEGORY/value

Or directly calling the executable

konsum insert ev 90091.3 '2019-06-22T13:44:17'

openapi

see openapi

API

Table of Contents

• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute
• addRoute

addRoute

Stop konsum server.

addRoute

Reload konsum systemd config.

addRoute

Create backup on server.

addRoute

Backup data as text.

addRoute

Retrieve service state.

addRoute

Login to request api token. At least one entitlement starting with "konsum" is required.

addRoute

Retrieve list of categories.

addRoute

Add a new category.

addRoute

Delete a category.

addRoute

List values of a category.

addRoute

Insert a value into a category.

addRoute

Delete a value from a category.

addRoute

List meters/notes of a category.

addRoute

Add a meter/note to a category.

addRoute

Update a meter/note.

addRoute

Delete a meter/note.