Integration von Govee Lights

axe

Die Govee Lampen, Lichtbänder, Lichtvorhänge und was es noch alles von Govee gibt, lassen sich gut über die public Govee API steuern.

Wie gehts:

individuellen API-Key beantragen:
Govee App starten, rechts unten das Profil-Icon klicken, rechts oben in die Einstellungen gehen => API-Schlüssel beantragen wählen. Der Key kommt dann per Email.
einmalig einen HTTP GET Request senden, um die Daten der eigenen Govee Geräte zu ermitteln. Hierfür eignet sich das Tool "Postman" oder ein anderes mit dem man REST-API Requests senden kann.

GET Request URL: https://openapi.api.govee.com/router/api/v1/user/devices
Request Header: Key: Govee-API-Key Value: <individueller API Key aus Schritt 1>

Image description

Als Antwort bekommt man etwas in der Form

{ "code": 200, "message": "success", "data": [ { "sku": "<individuell pro Gerät>", "device": "<individuell pro Gerät>", "deviceName": "<individuell wie man das Gerät in der Govee app benannt hat>", "type": "devices.types.light", "capabilities": [ { "type": "devices.capabilities.on_off", "instance": "powerSwitch",

man braucht davon die folgenden Daten: sku und device. Hat man mehrere Govee Devices findet man pro Gerät einen eigenen sku und device Wert.

In der P44 ein neues Scripted Device hinzufügen mit

init-message:

{'message':'init','protocol':'simple','name':'govee','colorclass':1,'group':1,'output':'colorlight'}

name kann man natürlich selber vergeben wie das Gerät heissen soll.

implementation script:

on (message()) as m { 
  log('vdc->device message: %s', m)

  var govee_device = '<device Wert aus Schritt 2'
  var govee_sku = '<sku Wert aus Schritt 2'
  var govee_key = '<individueller API key aus Schritt 1'
  
  var govee_api_control_url = 'https://openapi.api.govee.com/router/api/v1/device/control'
  var govee_api_state_url = 'https://openapi.api.govee.com/router/api/v1/device/state'
  
  var on_off = -1
  
  if (m == 'C0=0.000000') {
    log('govee OFF')
    
    on_off = 0
  }
  
  if (m == 'C0=100.000000') {
    log('govee ON')
    
    on_off = 1
  }
    
  var request_data_onoff = {
    'requestId' : 'test',    
    'payload' : {
      'sku' : govee_sku,
      'device' : govee_device,
      'capability' : {
        'type' : 'devices.capabilities.on_off',
        'instance' : 'powerSwitch',
        'value' : on_off
      }
    }
  }
    
  var request = {
    'url' : govee_api_control_url,
    'method' : 'POST',
    'headers' : {
      'Content-Type' : 'application/json',
      'Govee-API-Key' : govee_key,
      'accept' : 'application/json'
    }
  }
     
  if (on_off > -1) {
    var response = json(httprequest(request,request_data_onoff))
    log('Govee response: %s', response)      
  }
}

Danach hat man im DS Konfigurator ein neues Licht Device, dass sich wie üblich bedienen lässt in der DS App.

Achtung: Das implementation Script oben ist aktuell nur Licht ein / Licht aus. Setzen von Farbe kommt noch...

Wer selber erweitern möchte, die Doku der Govee API gibt es hier:

https://govee.readme.io/reference

axe

Updated implementation script, unterstützt nun auch das Setzen der Farbe:

@luz Ist das normal, dass DS bei einer Farbänderung 3 messages sendet, eine für Farbe, eine für Saturation, eine für brightness? Das hat zur Folge, dass ich für einmal Farbänderung 3 API requests für die govee LED machen muss und erst nach dem 3. die Farbe korrekt gesetzt ist. Oder kann man sich darauf verlassen, dass DS die messages immer in der Reihenfolge C0..... , C1=..... , C2=..... sendet und ich den Farbsetzen API call nur mache wenn die C2=.... message kommt und bei C0 und C1 message nur meine variablen entsprechend aktualisiere?
Allein das Konvertieren der Strings und Zahlen und Hex ist schon ein rechtes Gewürge.

on (message()) as m { 
  log('vdc->device message: %s', m)

  var govee_device = '<device Wert aus Schritt 2>'
  var govee_sku = '<sku Wert aus Schritt 2>'
  var govee_key = '<individueller API key aus Schritt 1>'
    

  var govee_api_control_url = 'https://openapi.api.govee.com/router/api/v1/device/control'
  var govee_api_state_url = 'https://openapi.api.govee.com/router/api/v1/device/state'
  
  var on_off
  var col_hue
  var col_sat
  var col_bright
  
  var sub1 = substr(m,0,2)
  var sub2 = substr(m,3)
  
  //log('SUB1: %s', sub1)
  //log('SUB2: %s', sub2)
  
  if (m == 'C0=0.000000') {
    log('govee OFF')    
    on_off = 0
  }
  
  if (sub1 == 'C0' && sub2 != '0.000000') {
    log('govee ON')
    on_off = 1
    var col_bright = number(sub2)   
  }
   
  if (sub1 == 'C1') {
    var col_hue = number(sub2)
  }
  if (sub1 == 'C2') {
    var col_sat = number(sub2)
  }
  
  var request_data_onoff = {
    'requestId' : random(1,10000000,1),    
    'payload' : {
      'sku' : govee_sku,
      'device' : govee_device,
      'capability' : {
        'type' : 'devices.capabilities.on_off',
        'instance' : 'powerSwitch',
        'value' : on_off
      }
    }
  }
    
  var request = {
    'url' : govee_api_control_url,
    'method' : 'POST',
    'headers' : {
      'Content-Type' : 'application/json',
      'Govee-API-Key' : govee_key,
      'accept' : 'application/json'
    }
  }
     
  if (on_off != undefined) {
    var response = json(httprequest(request,request_data_onoff))
    log('Govee response: %s', response)    
  }

  if (col_hue == undefined)  {
    var col_hue = 0
  }
  if (col_sat == undefined) {
    var col_sat = 0
  }
  if (col_bright == undefined) {
    var col_bright = 0
  }
  
  log('HUE: %s', col_hue)
  log('SAT: %s', col_sat)
  log('BRIGHT: %s', col_bright)
  
  var col_rgb = hsv(col_hue, col_sat/100, col_bright/100)
  
  log('RGB: %s', col_rgb)

  var request_data_color = {
    'requestId' : random(1,10000000,1),    
    'payload' : {
      'sku' : govee_sku,
      'device' : govee_device,
      'capability' : {
        'type' : 'devices.capabilities.color_setting',
        'instance' : 'colorRgb',
        'value' : number('0x'+substr(col_rgb,1))
      }
    }
  }
  
  if (on_off == 1) {
    var response = json(httprequest(request,request_data_color))
    log('Govee response: %s', response)      
  }  
}

luz

axe Allein das Konvertieren der Strings und Zahlen und Hex ist schon ein rechtes Gewürge

Der "simple" mode ist eigentlich nur für einfachste devices in Umgebungen ohne JSON-Support nützlich (eher historisch, in extern implementierten custom devices). In einem scripted device ist das JSON-protokoll viel einfacher zu handhaben, und deshalb auch der Default, wenn Du in der init-message kein protocol angibst.

axe Ist das normal, dass DS bei einer Farbänderung 3 messages sendet, eine für Farbe, eine für Saturation, eine für brightness?

Normal ja, optimal in der Form nicht.

Das liegt daran, dass offenbar selten scripted color lights erstellt wurden bisher 🤔 …

In der nächsten Beta 2.8.2.41 habe ich darum den Support für die Implementierung von scripted color lights folgendermassen verbessert:

die Kanaländerungen kommen nach wie vor separat, aber am Schluss kommt nun immer eine Message "apply", die angibt, dass jetzt alle Kanalwerte zusammen auf die Hardware angewandt werden sollen. Da kannst Du jetzt sowas machen (mit JSON-Protokoll!) wie:

var hue = 0
var saturation = 0
var brightness = 0

on (message()) as m {
  log('vdc->device message: %s', m)

  if (ifvalid(m.message=="channel", false)) {
    // Kanalwerte sammeln in Variablen
    if (ifvalid(m.id=="hue", false)) hue = m.value
    else if (ifvalid(m.id=="saturation", false)) saturation = m.value
    else if (ifvalid(m.id=="brightness", false)) brightness = m.value
  }
  else if (ifvalid(m.message=="apply", false)) {
    // hier jetzt die kompletten Farbdaten ans Gerät senden
    log("Neue Farben: hue=%d, saturation=%d, brightness=%d", hue, saturation, brightness)
  }
}

Es gibt in der init message neu eine Einstellung colormode. Wenn eine Leuchte z.B. nur hue/saturation kann, dann kann man "colormode":"HS" angeben, um immer nur Farben im hue/saturation mode zu bekommen, auch wenn der User CIE x/y oder Farbtemperatur vorgibt (dann rechnet das Farbmanagement in der P44 das um).
Wenn colormode auf RGB, RGBW oder RGBWA gesetzt wird, dann gibts vor den Kanaländerungen eine extra message primaries, mit den RGB(WA)-Farbwerten. Das ist für Leuchten, die man nicht in HSV oder XY ansteuern kann.

In der Online-Doku sind diese Neuerungen bereits enthalten.

Auf welchem Gerätetyp machst Du das? P44-DSB-D/DEH oder -E/-X?

axe

luz aaah good to know mit dem JSON mode. dann werde ich das bei Gelegenheit mal noch umbauen. mitzählen bis die 3 messages da sind hatte ich auch im Kopf, aber wenn dann doch mal eine message "verloren" geht funktionierts ja nicht mehr oder bräuchte einen counter reset fallback.
das mit der apply message schau ich mir an, klingt gut! 🙂 hab noch eine "alte" P44-DSB-E

axe

luz Top, mit JSON Protokoll ist es in der Tat viel einfacher und angenehmer 🙂

init-message:

{'message':'init','name':'test','colorclass':1,'group':1,'output':'colorlight'}

implementation script:

on (message()) as m { 
  log('vdc->device message: %s', m)

  var govee_device = '<device Wert aus Schritt 2>'
  var govee_sku = '<sku Wert aus Schritt 2>'
  var govee_key = '<individueller API key aus Schritt 1>'
    
  var govee_api_control_url = 'https://openapi.api.govee.com/router/api/v1/device/control'
  var govee_api_state_url = 'https://developer-api.govee.com/v1/devices/state'
  
  var col_hue
  var col_sat
  var col_bright
  
  if (ifvalid(m.message == 'channel',false)) {
    if (ifvalid(m.id == 'brightness',false)) {
      col_bright = m.value   
    }
    if (ifvalid(m.id == 'hue',false)) {
      col_hue = m.value   
    }
    if (ifvalid(m.id == 'saturation',false)) {
      col_sat = m.value   
    }
  }

  var request_data_onoff = {
    'requestId' : random(1,10000000,1),    
    'payload' : {
      'sku' : govee_sku,
      'device' : govee_device,
      'capability' : {
        'type' : 'devices.capabilities.on_off',
        'instance' : 'powerSwitch',
        'value' : number(col_bright > 0)
      }
    }
  }
    
  var request = {
    'url' : govee_api_control_url,
    'method' : 'POST',
    'headers' : {
      'Content-Type' : 'application/json',
      'Govee-API-Key' : govee_key,
      'accept' : 'application/json'
    }
  }
     
  var response = json(httprequest(request,request_data_onoff))
  log('Govee response: %s', response)    
 
  var col_rgb = hsv(col_hue, col_sat/100, col_bright/100)
  log('RGB: %s', col_rgb)

  var request_data_color = {
    'requestId' : random(1,10000000,1),    
    'payload' : {
      'sku' : govee_sku,
      'device' : govee_device,
      'capability' : {
        'type' : 'devices.capabilities.color_setting',
        'instance' : 'colorRgb',
        'value' : number('0x'+substr(col_rgb,1))
      }
    }
  }
  
  if (col_bright > 0) {
    var response = json(httprequest(request,request_data_color))
    log('Govee response: %s', response)      
  }  
}

luz

axe mitzählen bis die 3 messages da sind hatte ich auch im Kopf, aber wenn dann doch mal eine message "verloren" geht

Die gehen zwar nicht "verloren", aber es werden nur die Kanäle rapportiert, die sich tatsächlich ändern. Wenn also nur die Helligkeit verstellt wird, dann kommt kein hue und saturation. Deshalb geht mitzählen nicht, es braucht schon die "apply"-Message (2.8.2.41 für P44-DSB-E ist verfügbar ;-)

luz

Sehe in Deinem Code gerade, dass die Govee ja RGB-Daten will. Das geht nun mit v2.8.2.41 einfacher, du kannst einfach colormode auf RGB setzen in der Init-Message, und dann die neue "primaries"-Message auswerten, die direkt RGB liefert.

Neben dem einfacheren Code hat das auch den Vorteil, dass Farbkalibrierung pro Leuchte (durch Justieren der RGB-Matrix in den OutputSettings) möglich ist, während die hsv() fix die sRGB-D65-Werte verwendet.

RGB conversion matrix properties

axe

luz Super danke script wird immer kürzer 🙂 , jetzt mit apply message und colormode RGB:

init message:
{'message':'init','name':'test','colorclass':1,'group':1,'output':'colorlight', 'colormode':'RGB'}

implementation script:

on (message()) as m { 
  log('vdc->device message: %s', m)

  var govee_device = '<device Wert aus Schritt 2>'
  var govee_sku = '<sku Wert aus Schritt 2>'
  var govee_key = '<individueller API key aus Schritt 1>'
    
  var govee_api_control_url = 'https://openapi.api.govee.com/router/api/v1/device/control'
  var govee_api_state_url = 'https://developer-api.govee.com/v1/devices/state'
  
  var col_rgb

  if (ifvalid(m.message == 'primaries',false)) {
    col_rgb = (round(m.r/100*255) * 256 * 256) + (round(m.g/100*255) * 256) + round(m.b/100*255)
  } else if (ifvalid(m.message=="apply", false)) {
    var request_data_onoff = {
      'requestId' : random(1,10000000,1),    
      'payload' : {
        'sku' : govee_sku,
        'device' : govee_device,
        'capability' : {
          'type' : 'devices.capabilities.on_off',
          'instance' : 'powerSwitch',
          'value' : number(col_rgb > 0)
        }
      }
    }
    
    var request = {
      'url' : govee_api_control_url,
      'method' : 'POST',
      'headers' : {
        'Content-Type' : 'application/json',
        'Govee-API-Key' : govee_key,
        'accept' : 'application/json'
      }
    }
    
    var request_data_color = {
      'requestId' : random(1,10000000,1),    
      'payload' : {
        'sku' : govee_sku,
        'device' : govee_device,
        'capability' : {
          'type' : 'devices.capabilities.color_setting',
          'instance' : 'colorRgb',
          'value' : number(col_rgb)
        }
      }
    }
  
    var response = json(httprequest(request,request_data_color))
    log('Govee response: %s', response)    
    
    var response = json(httprequest(request,request_data_onoff))
    log('Govee response: %s', response)         
  }
}