Skip to content

kobold2mqtt is a gateway between a Vorwerk Kobold VR200 internet gateway and MQTT with the https://github.com/mqtt-smarthome topic and payload format.

License

Notifications You must be signed in to change notification settings

koeberlue/kobold2mqtt

 
 

Repository files navigation

VR200 to mqtt

mqtt-smarthome NPM version Dependency Status Build Status js-semistandard-style License: MIT

Written and (C) Kai Kramer on top of https://github.com/nicoh88/node-kobold from Arne Blumentritt and Nico Hartung. Build with https://github.com/hobbyquaker/xyz2mqtt-skeleton from Sebastian Raff.

Provided under the terms of the MIT license.

Overview

kobold2mqtt is a gateway between a Kobold VR200 vacuum and MQTT with the https://github.com/mqtt-smarthome topic and payload format.

Prerequisites

If you use the MyKobold app, you will probably need to login via OAuth2. For this you will have to obtain a token. Instructions for obtaining such a token can be found here.

Installation

The recommended away is via docker hub.

docker run --rm --env-file ./vr200.env -it krambox/kobold2mqtt

Or via direct call

./kobold2mqtt.js -u mqtt://192.168.1.13 -e <EMail> -p <pwd>

Or via direct call (OAuth2 token)

./kobold2mqtt.js -u mqtt://192.168.1.13 -t <token>

Config

Example Env file for docker run --env-file

VR200_url=mqtt://192.168.1.13
VR200_password=<Vorwerk password>
VR200_email=<Vorwerk username>

Example Env file for docker run --env-file with OAuth2

VR200_url=mqtt://192.168.1.13
VR200_token=<Vorwerk token>

Start

Set env variable koboldconfig to config.yml

Start kobold2mqtt.js

Docker

docker build -t kobold2mqtt .

docker run --rm --env-file ./vr200.env -it kobold2mqtt

Topics

kobold2mqtt respects the smarthome2mqtt scheme and exposes the vacuum cleaners state exemplarily:

Topic: vr200/status/<Kobold Name> 

Message:
{
  "ts": 1575615863,
  "isCharging": false,
  "isDocked": true,
  "isScheduleEnabled":true,
  "charge":93,
  "state":"stopped",
  "action":0
}

Changing the state is possible with the following set values on topic vr200/set/:

  • start
  • stop
  • pause
  • resume
  • doc

So to start the Vorwerk200, publish this message:

Topic: vr200/set/<Kobold Name>
Message: start

About

kobold2mqtt is a gateway between a Vorwerk Kobold VR200 internet gateway and MQTT with the https://github.com/mqtt-smarthome topic and payload format.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 91.4%
  • Dockerfile 8.6%