Разбираем протокол чайника Redmond G200S и подключаем его к HomeAssistant

Вступление


На Гиктаймс уже была статья, посвященная разбору протокола чайника Redmond SkyKettle. Однако там речь шла о модели RK-M171S, здесь же речь пойдет о более функциональном G200S. В данной модели изменился протокол взаимодействия, из за чего подход автора предыдущей статьи уже не работает, а также появились дополнительные функции ночника и индикации текущей температуры цветом.

В данной статье я приведу результаты разбора протокола с примерами кода на python (если кто захочет разработать свой модуль/приложение для управления чайником). Также в конце статьи ссылка на готовый модуль для подключения чайника к HomeAssistant (это мой первый опыт написания на python после прохождения онлайн-курса, так что данный модуль можно и даже нужно улучшать).

Всем, кому интересно, добро пожаловать под кат.

Проблемы и задачи


У данного чайника есть один большущий минус (кроме тех, что указал автор первой статьи): как только чайник снимаешь с подставки, происходит сброс текущего времени и, как следствие, невозможность использования расписания для кипячения чайника. По задумкам авторов сего творения, каждый раз после возвращения чайника на подставку ты должен запустить их фирменное приложение и синхронизировать чайник со смартфоном. Вот так вместо облегчения рутинных задач «умная» техника дрессирует нас совершать дополнительные действия. Но все изменилось, когда в доме появился HomeAssistant. Тогда я и решил разобраться в протоколе.

Инструменты


Я честно пытался декомпилировать и разобрать оригинальное приложение, но потерпел фиаско. Те инструменты, которые я использовал, не позволили мне понять логику работы чайника. Все процедуры и функции получались «кривыми», безымянными (по типу a, b, c и тд). Возможно, у меня не хватает опыта и умения. В итоге я пошел тем же путем, что и автор предыдущей статьи. Единственное существенное отличие в том, что я использовал интерактивный режим работы утилиты gatttool. Преимущество в том, что данный режим исключает всевозможные «гонки», о которых писал автор первой статьи.

Так как HomeAssistant написан на python, то все дальнейшие команды будем писать на нем. Для использования интерактивного режима работы gatttool на python нам поможет библиотека pexpect, позволяющая порождать сущности сторонних приложений и следить за их выводом (лихо загнул).

Практика


Про общее описание протокола обмена я вновь отправлю к автору первой статьи, поэтому без долгих прелюдий приступим к командам управления.

  1. Установка и разрыв соединения

    Устанавливаем соединение:

    child = pexpect.spawn("gatttool -I -t random -b " + mac, ignore_sighup=False)
    child.expect(r'\[LE\]>', timeout=3)
    child.sendline("connect")
    child.expect(r'Connection successful.*\[LE\]>', timeout=3)

    Здесь mac — мак адрес чайника.

    Разрываем соединение:

    child.sendline("exit")
  2. Подписка на уведомления

    После установления соединения перво-наперво нам надо подписаться на получение уведомлений от чайника. Без этого чайник будет воспринимать команды, однако не сможет ничего нам ответить, кроме текстового «Successfully».

    child.sendline("char-write-cmd 0x000c 0100")
    child.expect(r'\[LE\]>') 
  3. Авторизация

    child.sendline("char-write-req 0x000e 55" + iter + "ff" + key + "aa")
    child.expect("value: ")
    child.expect("\r\n")
    connectedStr = child.before[0:].decode("utf-8")
    answer = connectedStr.split()[3] # parse: 00 - no   01 - yes
    child.expect(r'\[LE\]>')

    Здесь и далее iter — целочисленная итерационная hex переменная от 0 до 64 (от 0 до 100 в десятичной системе). После каждой команды (как успешной, так и неуспешной) эту переменную следует увеличивать на 1, при достижении 64 она вновь сбрасывается на 0; key — hex 8 байт ключ авторизации (например: ffffffffffffffff).

    Пример ответа:
    value: 55 00 ff 01 aa
    Четвертый байт (01) означает, что чайник авторизовал вас, в противном случае ответ будет 00.
  4. Немного уличной магии
    После авторизации всегда отправляется «волшебный» запрос, суть которого мне не ясна. Есть теория, что он нужен для «удержания» состояния connected. Якобы если его не отправлять, то разрыв связи происходит в пределах секунды, и нужно начинать все заново. Если же его отправить, то таймаут существенно увеличивается, доходя до примерно десятка секунд. Достоверно подтвердить это я так и не смог.

    child.sendline("char-write-req 0x000e 55" + iter + "01aa")
    child.expect("value: ")
    child.expect("\r\n")
    child.expect(r'\[LE\]>')

    Пример ответа:
    value: 55 01 01 02 1d aa

    Во всех моих экспериментах ответ неизменно был таким.

    UPD: в комментариях подсказали, что никакая это не магия, а просто запрос версии ПО, в ответе соответственно именно эта версия и содержится. Таким образом, данный запрос можно вообще убрать за ненадобностью.
  5. Синхронизация
    Команда, синхронизирующая время в чайнике с часами сервера. У нее есть еще один эффект. В чайнике есть возможность показывать текущую температуру в режиме простоя миганием светодиода определенного цвета. Эта функция работает только после синхронизации. Описание самой функции см. в пункте 11.

    child.sendline("char-write-req 0x000e 55" + iter + "6e" + timeNow + tmz + "0000aa")
    child.expect("value: ")
    child.expect("\r\n")
    child.expect(r'\[LE\]>')

    Здесь tmz — часовой пояс в обратном hex формате (например, часовой пояс +3 переводим в секунды, затем в hex формат и получаем hex(3*60*60)=2a30, разбиваем по парам и выводим в обратном порядке 302a). Как быть с отрицательными часовыми поясами я не знаю, не тестировал, но есть подозрение, что за это отвечает следующий за tmz байт. Здесь timeNow — текущее время unixtime в обратном hex формате. Алгоритм такой же: получаем текущее время в секундах, переводим в HEX, разбиваем по парам и выводим строкой в обратном порядке.

    Пример ответа:
    value: 55 02 6e 00 aa
    Во всех моих экспериментах ответ неизменно был таким.
  6. Статистика
    В чайнике есть счетчик затраченной электроэнергии, общее время работы и количество пусков. Если кому то эти данные не нужны, можно смело пропускать данный пункт.

    child.sendline("char-write-req 0x000e 55" + iter + "4700aa")
    child.expect("value: ") 
    child.expect("\r\n") 
    statusStr = child.before[0:].decode("utf-8")
    Watts = hexToDec(str(statusStr.split()[11] + statusStr.split()[10] + statusStr.split()[9]))
    alltime = round(self._Watts/2200, 1)
    child.expect(r'\[LE\]>')
    
    child.sendline("char-write-req 0x000e 55" + iter + "5000aa")
    child.expect("value: ") 
    child.expect("\r\n") 
    statusStr = child.before[0:].decode("utf-8")
    times = hexToDec(str(statusStr.split()[7] + statusStr.split()[6]))
    child.expect(r'\[LE\]>')

    Watts — возвращает затраченную энергию в Вт*ч, alltime — время работы чайника в часах, times — количество запусков чайника. hexToDec — функция перевода в десятичный формат.
  7. Прочесть текущий режим работы

    child.sendline("char-write-req 0x000e 55" + iter + "06aa")
    child.expect("value: ") 
    child.expect("\r\n") 
    statusStr = child.before[0:].decode("utf-8")
    
    answer = statusStr.split()
    status = str(answer[11])
    temp = hexToDec(str(answer[8]))
    mode = str(answer[3])

    Пример ответа:
    value: 55 04 06 00 00 00 00 01 2a 1e 00 00 00 00 00 00 80 00 00 aa
    Четвертый байт — режим работы (mode): 00 — кипячение, 01 — нагрев до температуры, 03 — ночник. Шестой байт — hex температура, до которой нужно нагревать в режиме работы «нагрев», в режиме кипячения равен 00. Девятый байт — hex текущая температура воды (2a=42 по Цельсию). Двенадцатый байт — это состояние чайника: 00 — выключен, 02 — включен. Семнадцатый байт — это продолжительность работы чайника после достижения нужной температуры, по умолчанию равна 80 в hex (видимо, это какие то относительные единицы, точно не секунды).
  8. Записать текущий режим работы

    child.sendline("char-write-req 0x000e 55" + iter + "05" + mode + "00" + temp + "00000000000000000000" + howMuchBoil + "0000aa")
    child.expect("value: ")
    child.expect("\r\n")
    statusStr = child.before[0:].decode("utf-8")
    answer = statusStr.split()[3]
    child.expect(r'\[LE\]>')

    Параметр mode: 00 — кипячение, 01 — нагрев до температуры, 03 — ночник. Параметр temp — hex температура, до которой нужно нагревать в режиме работы «нагрев», в режиме кипячения он равен 00. Параметр howMuchBoil — это продолжительность работы чайника после достижения нужной температуры, по умолчанию равна 80 в hex (видимо, это какие то относительные единицы, точно не секунды).

    Пример ответа:
    value: 55 05 05 01 aa
    Четвертый байт ответа показывает успешность настроек: 01 — успешно, 00 — не успешно.
  9. Запустить текущий режим работы

    child.sendline("char-write-req 0x000e 55" + iter + "03aa")
    child.expect("value: ")
    child.expect("\r\n") 
    statusStr = self.child.before[0:].decode("utf-8")
    answer = statusStr.split()[3]
    child.expect(r'\[LE\]>')

    Пример ответа:
    value: 55 06 03 01 aa
    Четвертый байт ответа показывает успешность включения: 01 — успешно, 00 — не успешно.
  10. Остановить текущий режим работы

    child.sendline("char-write-req 0x000e 55" + iter + "04aa")
    child.expect("value: ") 
    child.expect("\r\n") 
    statusStr = self.child.before[0:].decode("utf-8")
    answer = statusStr.split()[3]
    child.expect(r'\[LE\]>')

    Пример ответа:
    value: 55 07 04 01 aa
    Четвертый байт ответа показывает успешность выключения: 01 — успешно, 00 — неуспешно.
  11. Отображение текущей температуры цветом в простое

    child.sendline("char-write-req 0x000e 55" + iter + "37c8c8" + onoff + "aa") # 00 - off, 01 - on
    child.expect("value: ")
    child.expect("\r\n") 
    child.expect(r'\[LE\]>')

    Параметр onoff равен либо 01 — включить функцию, либо 00 — выключить функцию.

    Пример ответа:
    value: 55 08 37 00 aa
    Во всех моих экспериментах ответ неизменно был таким.
  12. Записать палитру цветов различных режимов работы
    Устанавливается палитра соответствия между цветом светодиода и температурой в режиме отображения текущей температуры и режимах нагрева и кипячения, а также палитра цветов в режиме ночника.

    child.sendline("char-write-req 0x000e 55" + iter + "32" + boilOrLight + scale_from + rand + rgb1 + scale_mid + rand + rgb_mid + scale_to + rand + rgb2 + "aa") 
    child.expect("value: ")
    child.expect("\r\n")
    child.expect(r'\[LE\]>')

    Параметр boilOrLight равен 00, если мы настраиваем режим отображения текущей температуры или 01, если мы настраиваем режим ночника. Параметр scale_from указывает начало диапазона изменения цвета и равен 00 в режиме ночника и 28 в режиме отображения текущей температуры (28 — это 40 в десятичном формате и именно с этой температуры начнется плавное изменение цвета). Параметр scale_mid — это середина диапазона и равен 32 в режиме ночника и 46 в режиме отображения текущей температуры. Параметр scale_to указывает конец диапазона изменения цвета и равен 64 в обоих режимах. Параметр rgb1 — hex цвет начала палитры. Параметр rgb_mid — hex цвет середины палитры (я вычисляю его как середину между левым и правым концом, но теоретически можно задать любой цвет, это повлияет только на красивость и плавность смены цвета). Параметр rgb2 — hex цвет конца палитры. Параметр rand — некий параметр, значение которого я точно не понял, возможно, как то связан с яркостью цвета (примеры значений: e5, cc).

    Пример ответа:
    value: 55 09 32 00 aa
    Во всех моих экспериментах ответ неизменно был таким.
  13. Прочесть палитру цветов различных режимов работы

    child.sendline("char-write-req 0x000e 55" + iter + "33" + boilOrLight + "aa") 
    child.expect("value: ")
    child.expect("\r\n")
    statusStr = self.child.before[0:].decode("utf-8")
    child.expect(r'\[LE\]>')

    Параметр boilOrLight может быть 00 — если мы настраиваем режим отображения текущей температуры или 01 — если мы настраиваем режим ночника.

    Пример ответа:
    value: 55 10 33 01 00 7f 00 00 ff 32 7f 00 ff 00 64 7f ff 00 00 aa
    Здесь шестой, одиннадцатый и шестнадцатый байты (7f) это параметр rand из пункта 12. Пятый байт — scale_from, десятый байт — scale_mid, пятнадцатый байт — scale_to. Седьмой+восьмой+девятый байты — rgb_from. Двенадцатый+тринадцатый+четырнадцатый байты — rgb_mid. Семнадцатый+восемнадцатый+девятнадцатый байты — rgb_to.

Заключение


Если gatttool не желает подключаться к чайнику (такое возможно при первом подключении к неизвестным устройствам), то попробуйте выполнить поиск чайника средствами os до подключения модуля:

sudo hciconfig device reset
sudo timeout 1 hcitool lescan


device — id вашего блютус устройства (например, hci0). Убедитесь, что мак адрес вашего чайника есть в списке найденных устройств. После этого:

sudo hcitool lewladd mac
sudo hcitool lerladd mac


mac — мак адрес вашего чайника

UPD6: Существенно доработал модуль чайника:
1. Перевел модуль с платформы на режим интеграции
2. После добавления у вас автоматически появится 3 элемента: водный нагреватель (текущая температура, целевая температура, кипячение и нагрев), сенсор (время синхронизации, затрачено энергии, часов работы, количество включений) и свет (можно использовать как ночник и выбирать любой цвет подсветки)
3. теперь модуль доступен на GitHub.
4. Модуль поддерживает установку через HACS
5. Пример конфигурации:
r4s_kettler:
    device: 'hci0'
    mac: 'FF:FF:FF:FF:FF:FF'
    password: 'ffffffffffffffff'


Скриншоты новой версии
image
image
image
image


UPD7: Удалил неактуальную информацию
Share post
AdBlock has stolen the banner, but banners are not teeth — they will be back

More
Ads

Comments 28

    0
    Сожжено энергии

    Потрачено (с)
    А почему не угля?))
      0

      Как всегда: готовишь ответы на все каверзные вопросы, прокручиваешь все возможные сценарии в голове, а тут — бац! И весь сценарий накрылся. К такому меня жизнь не готовила.
      А по факту: ваш вариант звучит конечно же более правильно )

        0
        Я если честно, даже не сразу обратил внимание, а когда обратил — не сразу понял, что именно меня привлекло, то что сожжено энергии, или таки что размерность в Ваттах, а не в Джоулях)
          0

          А вот это уже промах с моей стороны. Не отмажешься сказками про деревенский акцент)) Спасибо, что заметили… стыдно. кВт*ч конечно же.

            0
            поправил
        +1
        >SkyKettle
        Рассел задумчиво смотрит в пустую чашку…
          +1
          Рассел задумчиво смотрит в пустую чашку…


          Количество запусков — 545 раз.


          0
          И ни слова про блокчейн с майниногм.
            0
            Ура! Наконец что-то полезное, а не очередной градусник.
            Спасибо за статью!
              0

              Рад, что вам понравилось.

              +1
              Мне кажется, многим было бы понятнее, если бы протокол был описан в терминах GATT, а не только в виде примеров кода на Python, то есть, какие там службы и характеристики, что туда можно читать/писать и в каком формате.
                0

                Совершенно согласен. Однако сделал это осознанно. Статья и без того получилась объемной, экономил как мог. К тому же она более практическая с уклоном применения в HomeAssistant. В самом начале я оставил ссылку на статью другого автора, там есть описание протокола в нужных вам терминах, там не так много поменялось. К тому же в моем коде за оберткой из pexpect довольно легко увидеть "голый" gatttool, например, легко видеть "хендлы", к которым обращаюсь, а также сами команды. Команды и ответы содержат последовательность байтов информации. Те байты, в которых я разобрался приведены с описаниями, чтобы их можно было правильно задать или прочесть.

                0

                Спасибо, как раз купил на пробу два стартовых комплекта розетка+цоколь от Редмонд и думал, как их при случае в рамки стандарта загнать, чтобы докупать другие устройства от других производителей (вроде ни аналога реле sonoff, ни диммеров у Редмонд нету), а тут как раз впша статья — можно будет малой кровью справиться по аналогии.

                  0

                  Да, я уже указывал в статье, что в идеале бы написать общий компонент Ready4Sky с возможностью подключения любого устройства из серии.
                  Насчет малой крови — это как посмотреть. Разобравшись в официальном приложении получаешь все устройства серии, а описанный тут путь — это грубое решение
                  конкретной задачи в лоб )) Если бы исходники официального приложения в удобоваримом виде получить...

                  0
                  Разбираем протокол чайника


                  И чайник шепнул утюгу:
                  «Я дальше идти не могу»…
                  Корней Чуковский
                    0
                    Господи, разбор протокола обмена данными с чайником.
                    Жить в 2018 — это офигенно.
                      0

                      Более того, на него ещё и обновления ставить нужно. У меня он из коробки не кипятил (отключался слишком рано), пришлось идти с ним в сервис, чтобы там подключились к нему телефоном (мой на тот момент не умел в BLE) и обновили прошивку.

                        0

                        Да, обновить чайник — это звучит. К сожалению ожидания не всегда соответствуют реалиям. Данный чайник обновился у меня всего раз, сразу после покупки. Либо прошивка получилась прям идеальной, либо не очень это нужно производителю — лучше новых устройств наклепать, чем улучшать старые.

                      0

                      У меня в планах на неопределённое будущее есть разработка альтернативного приложения для этого чайника. Родное уже достало — сразу не подключается, приходится несколько раз тыкать на кнопку "повтор", а потом ещё и каждый раз переключать с кипячения на нагрев. Если руки дойдут, ваш разбор очень пригодится.


                      А ещё чайнику очень не хватает возможности узнать, сколько в нём осталось воды. Есть идея попробовать встроить в подставку весы с ESP8266 или чем-то подобным.

                        0

                        Возможно, нестабильность — это не вина приложения, а вина аппаратной\программной части самого чайника. У меня в HomeAssistant тоже иногда проскакивают ошибки коннекта. Я специально для этого и ввел параметр "время обновления состояния", чтобы наблюдать за этим. Абсолютно не критично оказалось: все автоматизации, связанные с чайником, работают как часы! В моменты ручного запуска\остановки из интерфейса HomeAssistant тоже ни разу не подводил.
                        По поводу датчика уровня — согласен, не хватает. В описании к чайнику было сказано, что он не будет кипятиться, если нет воды… я потратил вечер, чтобы найти этот параметр в запросах\ответе, пока не провел эксперимент. Реальность больно ударила меня: там тупо термореле стоит, а не датчик уровня… а я так надеялся. Если его включить пустым, то он включится и через несколько секунд его вырубит защита.

                          0

                          Если идея осуществится — обязательно поделитесь ;)

                          0
                          Давно руки чесались «поковырять» его… а тут всё готовое, на блюдечке.

                          Но довольно коварный чайник. :( У меня он часто отказывается самостоятельно отключаться, хотя вода вовсю кипит. Приходится следить за ним, без присмотра оставлять просто опасно. При желании в сети можно найти отзывы с такой же проблемой, так что случай, увы, не единичный.

                          Плюс конфликтует с моноколесом. Софтина для управления колесом то и дело пытается подключиться к чайнику. :) Больше ни с одним девайсом такого не возникает. Возможно, что-то общее между ними есть.
                            0
                            К счастью, никогда не сталкивался с подобным поведением. Особенно в плане не отключения после кипячения. Может проблема как раз с параметром, который у меня называется howMuchBoil? Не пробовали в фирменном приложении уменьшать его?
                              0
                              Этот баг весьма рандомный. Может отключиться, а может и не отключиться, какой-то зависимости от чего-либо замечено не было.
                              В принципе, могу поэкспериментировать, конечно… Но из-за этой рандомности сложно судить о результатах.

                              edit: сейчас что-то подумалось, может датчик температуры глючит как-то… что-то я не догадался по приложению глянуть.
                                0
                                Удалось словить ситуацию. Действительно, что-то с определением температуры. Зависло на 94 градусах и оставалось так около минуты, дальше ждать не стал, ибо кипяток уж выплёскиваться начал.
                            0
                            Вот так HTTP 418 из невинной шутки превращается в самый обычный статус-код…
                              0
                              Очевидно же, что
                              > 55 01 01 02 1d aa
                              — это версия ПО (2.29) — и никаких там таймаутов на дисконнект.

                              > Здесь tmz — часовой пояс в обратном hex формате (например, часовой пояс +3 переводим в секунды, затем в hex формат и получаем hex(3*60*60)=2a30, разбиваем по парам и выводим в обратном порядке 302a)

                              мозг взорвался. называется просто «little-endian».
                                0
                                Вот и нет больше уличной магии.
                                Спасибо за находку ) Этот запрос можно вообще убрать из модуля.
                                Насчет «little-endian» утверждать не буду, но данным термином не пользовался, так как не весь ответ от чайника соответствует данной концепции, а лишь отдельные байты. Возможно, не прав.

                              Only users with full accounts can post comments. Log in, please.