[CCU.IO]RooWifi Roomba Adapter

[pix]

Hallo,
ich habe mich mal auf neues Terrain begeben. Nach Vorlage des owm-Adapters (Danke BasGo), habe ich einen Adapter zur Erfassung der Sensordaten des RooWifi Moduls für Roomba Staubsaugerroboter gebastelt.
Vorraussetzung ist die Einbindung des Roombas ins Netzwerk (nicht Adhoc). Bei mir funktionieren die Aufrufe über

Code: Alles auswählen

http://roomba

weshalb die IP-Adresse erstmal egal ist.
Die Steuerung erfolgt über die URL bzw. request() in einem seperaten ccu.io-Skript. Dieses setzt den Ping Adapter voraus.

Code: Alles auswählen

setObject(100053, {
    Name: 'Roomba Steuerung',
    DPInfo: 'Steuerbefehle für den Roomba',
    TypeName: 'VARDP',
    ValueMin: 0,
    ValueMax: 7,
    ValueUnit: '',
    ValueType: 16,
    ValueSubType: 29,
    ValueList: 'wartend;CLEAN;SPOT;DOCK',
    _persistent: true
});

// Steuerung mit CGI-Befehl ValueList: 'wartend;CLEAN;SPOT;DOCK',
var idRoombaBefehl = 100053,
    url = 'http://roomba/roomba.cgi?button=',
    befehl = 'wartend';

subscribe( {
    id: idRoombaBefehl,
    change: 'ne'
}, function (data) {
    if (data.newState.value == 1) { // CLEAN
        befehl = 'CLEAN'
    } else if (data.newState.value == 2) { // SPOT
        befehl = 'SPOT'
    } else if (data.newState.value == 3) { // DOCK
        befehl = 'DOCK'
    } else if (data.newState.value == 0) { // IDLE oder wartend
        befehl = 'wartend'
    }
    
    if (befehl != 'wartend') {
        var ping = getState(idRoombaPing);
        if (ping == true) {
            request(url+befehl, function (error, response, body) {
                log('Roomba Befehl <'+ url + befehl + '> liefert zurück: error (' + error + ' ) response (' + response + ') body ' + body + ')');
            });
        } else {
            log('Roomba im Netzwerk nicht erreichbar (kein Ping), Befehl nicht ausgeführt');
        }
        setTimeout(function () {
            befehl = 'wartend';
            setState(idRoombaBefehl, 0); // wartend
        }, 2000); // verzögert um 2Sekunden
    }
});

Das ganze ist absolut am Anfang. Jetzt, wo der Anfang gemacht ist und alle Variablen eingelesen werden (aus http://roomba/roomba.json), könnte vielleicht noch ein Profi mal drübergucken.

roomba.js

Code: Alles auswählen

/**
 *      ROOMBA RooWifi Adapter zum Auslesen der Sensordaten
 *      by Pix 5.7.2014
 *      Version 0.3
 *      weitestgehend basierend auf dem
 *         CCU.IO OpenWeatherMap Adapter
 *         02'2014 BasGo
 *         mail: basgo@gmx.de
 *         Version 0.2
 *      
 *      http:// Roomba_Wifi_Remote_IP /roomba.cgi?button=CLEAN
 *      http:// Roomba_Wifi_Remote_IP /roomba.cgi?button=SPOT
 *      http:// Roomba_Wifi_Remote_IP /roomba.cgi?button=DOCK
 *      evtl. 
 *      http://roomba/roomba.cgi?button=DOCK
 */
var settings = require(__dirname + '/../../settings.js');

if (!settings.adapters.roomba || !settings.adapters.roomba.enabled) {
    process.exit();
}

var roombaSettings = settings.adapters.roomba.settings;

var pollingInterval = roombaSettings.period || 5;

var reqOptions = {
    // host: roombaSettings.roombaIP,
    // host: '192.168.178.42',   
    host: 'roomba',            
    port: 80,
    path: '/roomba.json',
    method: 'GET'
};

var logger = require(__dirname + '/../../logger.js'),
    io     = require('socket.io-client'),
    http   = require('http');

	
if (settings.ioListenPort) {
    var socket = io.connect("127.0.0.1", {
        port: settings.ioListenPort
    });
} else if (settings.ioListenPortSsl) {
    var socket = io.connect("127.0.0.1", {
        port: settings.ioListenPortSsl,
        secure: true
    });
} else {
    process.exit();
}

function logDebug(message) {
    if (roombaSettings.debugEnabled) {
        logger.info("adapter roomba   " + message);
    }
}

function logInfo(message) {
    logger.info("adapter roomba   " + message);
}

function logWarning(message) {
    logger.warn("adapter roomba   " + message);
}

socket.on('connect', function () {
    logDebug("connected to ccu.io");
});

socket.on('disconnect', function () {
    logDebug("disconnected from ccu.io");
});

function stop() {
    logDebug("terminating");
    setTimeout(function () {
        process.exit();
    }, 250);
}

process.on('SIGINT', function () {
    stop();
});

process.on('SIGTERM', function () {
    stop();
});


function analyzeResult(result) {
    var curBumps         = result["response"]["r0"]["value"];
    var curWall          = result["response"]["r1"]["value"];
    var curCliffL        = result["response"]["r2"]["value"];
    var curCliffFL       = result["response"]["r3"]["value"];
    var curCliffFR       = result["response"]["r4"]["value"];
    var curCliffR        = result["response"]["r5"]["value"];
    var curVirtualWall   = result["response"]["r6"]["value"];
    var curMoverC        = result["response"]["r7"]["value"];
    var curDirtL         = result["response"]["r8"]["value"];
    var curDirtR         = result["response"]["r9"]["value"];
    var curRemote        = result["response"]["r10"]["value"];
    var curButtons       = result["response"]["r11"]["value"];
    var curDistance      = result["response"]["r12"]["value"];
    var curAngle         = result["response"]["r13"]["value"];
    var curChargingState = result["response"]["r14"]["value"];
    var curVoltage       = result["response"]["r15"]["value"];
    var curCurrent       = result["response"]["r16"]["value"];
    var curTemp          = result["response"]["r17"]["value"];
    var curCharge        = result["response"]["r18"]["value"];
    var curCapacity      = result["response"]["r19"]["value"];

    logInfo("received data (Temperature: "+curTemp+"°C, Charge: "+curCharge+"mAh, Capacity: "+curCapacity+"mAh)");

    socket.emit("setState", [roombaSettings.firstId + 2, curBumps]);
    socket.emit("setState", [roombaSettings.firstId + 3, curWall]);
    socket.emit("setState", [roombaSettings.firstId + 4, curCliffL]);
    socket.emit("setState", [roombaSettings.firstId + 5, curCliffFL]);
    socket.emit("setState", [roombaSettings.firstId + 6, curCliffFR]);
    socket.emit("setState", [roombaSettings.firstId + 7, curCliffR]);
    socket.emit("setState", [roombaSettings.firstId + 8, curVirtualWall]);
    socket.emit("setState", [roombaSettings.firstId + 9, curMoverC]);
    socket.emit("setState", [roombaSettings.firstId + 10, curDirtL]);
    socket.emit("setState", [roombaSettings.firstId + 11, curDirtR]);
    socket.emit("setState", [roombaSettings.firstId + 12, curRemote]);
    socket.emit("setState", [roombaSettings.firstId + 13, curButtons]);
    socket.emit("setState", [roombaSettings.firstId + 14, curDistance]);
    socket.emit("setState", [roombaSettings.firstId + 15, curAngle]);
    socket.emit("setState", [roombaSettings.firstId + 16, curChargingState]);
    socket.emit("setState", [roombaSettings.firstId + 17, curVoltage]);
    socket.emit("setState", [roombaSettings.firstId + 18, curCurrent]);
    socket.emit("setState", [roombaSettings.firstId + 19, curTemp]);
    socket.emit("setState", [roombaSettings.firstId + 20, curCharge]);
    socket.emit("setState", [roombaSettings.firstId + 21, curCapacity]);

}

function getValues() {
    logDebug("Checking values ...");
    var req = http.get(reqOptions, function(res) {
    var pageData = "";
    res.on('data', function (chunk) {
        pageData += chunk;
    });
    res.on('end', function () {
        var result = JSON.parse(pageData);
        analyzeResult(result);
    });
    });

    req.on('error', function(e) {
    logWarning("received error: "+e.message);
    });

    req.end();
}

function roombaInit() {

    socket.emit("setObject", roombaSettings.firstId, {
        Name: "Roomba RooWifi",
        TypeName: "DEVICE",
        HssType: "roomba",
        Address: "Roomba",
        Interface: "CCU.IO",
        Channels: [
            roombaSettings.firstId + 1,
            roombaSettings.firstId + 2
        ],
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 1, {
        Name: "Roomba",
        TypeName: "CHANNEL",
        Address: "Roomba Sensor Daten",
        HssType: "RooWifi-DATA",
        DPs: {
            BUMPS: roombaSettings.firstId + 2,
            WALL: roombaSettings.firstId + 3,
            CLIFF_LEFT: roombaSettings.firstId + 4,
            CLIFF_FRONTLEFT: roombaSettings.firstId + 5,
            CLIFF_FRONTRIGHT: roombaSettings.firstId + 6,
            CLIFF_RIGHT: roombaSettings.firstId + 7,
            VIRTUAL_WALL: roombaSettings.firstId + 8,
            MOTOR_OVERCURRENTS: roombaSettings.firstId + 9,
            DIRT_LEFT: roombaSettings.firstId + 10,
            DIRT_RIGHT: roombaSettings.firstId + 11,
            REMOTE: roombaSettings.firstId + 12,
            BUTTONS: roombaSettings.firstId + 13,
            DISTANCE: roombaSettings.firstId + 14,
            ANGLE: roombaSettings.firstId + 15,
            CHARGING_STATE: roombaSettings.firstId + 16,
            VOLTAGE: roombaSettings.firstId + 17,
            CURRENT: roombaSettings.firstId + 18,
            TEMPERATURE: roombaSettings.firstId + 19,
            CHARGE: roombaSettings.firstId + 20,
            CAPACITY: roombaSettings.firstId + 21
        },
        "Parent": roombaSettings.firstId,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 2, {
        Name: "Bumps Wheeldrops",
        DPInfo: "Bumps Wheeldrops",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 3, {
        Name: "Wall",
        DPInfo: "Wand",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 4, {
        Name: "Cliff left",
        DPInfo: "Klippe links",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });
    
    socket.emit("setObject", roombaSettings.firstId + 5, {
        Name: "Cliff front left",
        DPInfo: "Klippe vorn links",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });
    
    socket.emit("setObject", roombaSettings.firstId + 6, {
        Name: "Cliff front right",
        DPInfo: "Klippe vorn rechts",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 7, {
        Name: "Cliff right",
        DPInfo: "Klippe rechts",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 8, {
        Name: "Virtual Wall",
        DPInfo: "virtuelle Wand",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 9, {
        Name: "Motor Overcurrents",
        DPInfo: "Motorüberstrom",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 10, {
        Name: "Dirt Detector Left",
        DPInfo: "Schmutzerkennung links",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 11, {
        Name: "Dirt Detector Right",
        DPInfo: "Schmutzerkennung rechts",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 12, {
        Name: "Remote Operation Code",
        DPInfo: "Remote Opcode",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 13, {
        Name: "Buttons",
        DPInfo: "Tasten",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 14, {
        Name: "Distance",
        DPInfo: "Entfernung",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueUnit": "mm",
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 15, {
        Name: "Angle",
        DPInfo: "Winkel",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueUnit": "mm",
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });    
    
    socket.emit("setObject", roombaSettings.firstId + 16, {
        Name: "Charging State",
        DPInfo: "Ladestatus",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });    
    
    socket.emit("setObject", roombaSettings.firstId + 17, {
        Name: "Voltage",
        DPInfo: "elektr. Spannung",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueUnit": "mV",
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 18, {
        Name: "Current",
        DPInfo: "elektr. Strom",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueUnit": "mA",
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });
    
    socket.emit("setObject", roombaSettings.firstId + 19, {
        Name: "Temperature",
        DPInfo: "Temperatur",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueUnit": "°C",
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 20, {
        Name: "Charge",
        DPInfo: "Ladung",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueUnit": "mAh",
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

    socket.emit("setObject", roombaSettings.firstId + 21, {
        Name: "Capacity",
        DPInfo: "Akku Kapazität",
        TypeName: "VARDP",
        "ValueMin": null,
        "ValueMax": null,
        "ValueUnit": "mAh",
        "ValueType": 4,
        "Parent": roombaSettings.firstId + 1,
        _persistent: true
    });

     
    // Fix polling interval if too short
    if (pollingInterval <= 1) {
        pollingInterval = 1;
    }

    logInfo("polling enabled - interval " + pollingInterval + " minutes");

    setInterval(getValues, pollingInterval * 1 * 60 * 1000);
    getValues();
}

roombaInit();

settings.html

Code: Alles auswählen

<table style="font-size: 12px">
    <tr>
        <td>Enabled:</td>
        <td>
            <select id="roomba_enabled">
                <option value="false">false</option>
                <option value="true">true</option>
            </select>
        </td>
    </tr>
    <tr>
        <td>First ID:</td>
        <td colspan="6"><input id="roomba_firstId" type="number" min="77000"/></td>
    </tr>
    <tr>
        <td>Period (minutes):</td>
        <td><input id="roomba_period" type="number" min="1"/></td>
    </tr>
    <tr>
        <td>RooWifi IP:</td>
        <td><input size="72" id="roomba_ip" type="text"/></td>
    </tr>
    <tr>
        <td>Debug enabled:</td>
        <td colspan="6">
            <select id="roomba_debugEnabled">
                <option value="false">false</option>
                <option value="true">true</option>
            </select>
        </td>
    </tr>
</table>
<br /><br />
<h1>Hilfe</h1>
<table style="font-size: 12px">
    <tr><td colspan="3" style="font-size: 14px"><b>Roomba Adapter</b></td></tr>
    <tr><td colspan="3">&nbsp;</td></tr>
    <tr><td colspan="3">Der Roomba Adapter funktioniert mit dem RooWifi Modul, wenn dieses auf den WLAN Login konfiguriert ist. RooWifi und CCU.IO müssen im gleichen Netzwerk sein. Der Aufruf des RooWifi erfolgt standardmäßig über "http://roomba". Deshalb ist die Eingabe der IP zu vernachlässigen. Die Steuerung durch die AJAX Request Commands erfolgt in einem seperaten Script. Dieser Adapter liefert nur die Sensor Daten.</td></tr>
</table>
<script type="text/javascript">

    function storeSettings () {
        updateAdapterSettings();
    }
	
    if (currentAdapterSettings.enabled) {
        $("#roomba_enabled option[value='false']").removeAttr("selected");
        $("#roomba_enabled option[value='true']").attr("selected", true);
    } else {
        $("#roomba_enabled option[value='true']").removeAttr("selected");
        $("#roomba_enabled option[value='false']").attr("selected", true);
    }

    $("#roomba_enabled").change(function () {
        currentAdapterSettings.enabled = ($("#roomba_enabled option:selected").val() == "false" ? false : true);
        storeSettings();
    });

    if (currentAdapterSettings.settings.debugEnabled) {
        $("#roomba_debugEnabled option[value='false']").removeAttr("selected");
        $("#roomba_debugEnabled option[value='true']").attr("selected", true);
    } else {
        $("#roomba_debugEnabled option[value='true']").removeAttr("selected");
        $("#roomba_debugEnabled option[value='false']").attr("selected", true);
    }

    $("#roomba_debugEnabled").change(function () {
        currentAdapterSettings.settings.debugEnabled = ($("#roomba_debugEnabled option:selected").val() == "false" ? false : true);
        storeSettings();
    });

    $("#roomba_period").val(currentAdapterSettings.settings.period);

    $("#roomba_period").change(function () {
        currentAdapterSettings.settings.period = $("#roomba_period").val();
        storeSettings();
    });

    $("#roomba_ip").val(currentAdapterSettings.settings.roombaIP);

    $("#roomba_ip").change(function () {
        currentAdapterSettings.settings.roombaIP = $("#roomba_ip").val();
        storeSettings();
    });

    $("#roomba_firstId").val(currentAdapterSettings.settings.firstId);

    $("#roomba_firstId").change(function () {
        currentAdapterSettings.settings.firstId = $("#roomba_firstId").val();
        storeSettings();
    });
</script>

roomba.json

Code: Alles auswählen

{
  "enabled": true,
  "settings": {
    "roombaIP": "192.168.178.42",
    "firstId": 77100,
    "period": "2",
    "debugEnabled": false
  }
}

Gruß
Pix

[snake1024]

Hallo,
der Thread ist ja schon ein wenig älter. Mich interessiert das Thema auch extrem und ich würde gerne wissen ob es sich lohnt den Adapter zu bestellen? Hat das ganze jemand sauber am laufen über CCU.IO? Wie ist denn der Status des Projektes?

Ich bedanke mich für die Mühe!

[pix]

Hallo snake1024,

ich habe die Hardware schon einige Zeit in Benutzung. Alle 4 Wochen etwa muss ich die Wifi-Anbindung neu konfigurieren. Das passiert aber eigentlich nur, wenn der Roomba sich mal wieder in der Wohnung verhakt hat und der Akku danach leer ging. Ob es sich lohnt, muss jeder für sich entscheiden. Ich sehe es als Spielerei. Der Roomba könnte zwar automatisch bei Abwesenheit mit der Arbeit loslegen, doch bedarf es zuvor in meiner Wohnung noch einiger Räumarbeiten. Und wenn ich dann schon Hundebetten, Hocker und Spielzeug wegräume, kann ich auch schnell noch den Roomba starten.

Gruß
Pix

[snake1024]

Hi,

danke für die Antwort und für die Arbeit die du reingesteckt hast. Ich werde mal schauen ob ich es auch mache. Finde es sehr praktisch, da ich es gut an meinem Wandtablet benutzen könnte mit einigen Funktionen und Informationen.
Der Adapter ist wohl eh erstmal bit Januar ausverkauft...

[virgin]

Liebe Roomba Freunde,

Mal eine kleine Zufriedenheitsumfrage: ich habe auch den Roomba mit dem spanischen Wifi modul. Und war zunächst auch sehr zufrieden. Die Verbindung klappte, alles gut.

Jetzt aber stelle ich fest, dass die WLAN Verbindung immer mal wieder weg ist - scheinbar grundlos. Zumindest habe ich keine Erklärung. Reset (Knopf) hilft nichts. Ich muss dann die Batterie rausnehmen, alles stromlos machen. Dann geht es wieder.

Meine Frage: bin ich da ein bedauerlicher Einzelfall? Woran könnte es liegen? Oder habt ihr die gleichen Probleme?

Danke für zahlreiche Antworten!