Skip to content

Latest commit

 

History

History
117 lines (80 loc) · 3.42 KB

README.md

File metadata and controls

117 lines (80 loc) · 3.42 KB
Raw

Daichi Comfort Cloud API

Comfort cloud API wrapper to control HVAC (web.daichicloud.ru)

Table of contents

Installation & Quickstart

$ npm i daichi
import { DaichiApi } from './api'

const daichi = new DaichiApi('[email protected]', 'login_password_123')
const devices = await daichi.getDevices()

API

class DaichiApi(username: string, password: string, daichiApi?: string, clientId?: string)

Params:

  • username (string) - required
  • password (string) - required
  • daichiApi (string) - optional, defaults to https://web.daichicloud.ru/api/v4/
  • clientId (string) - optional, defaults to sOJO7B6SqgaKudTfCzqLAy540cCuDzpI

getBuildings()

Returns: Promise<DaichiBuilding[]>

getDevices()

Returns: Promise<DaichiDevice[]>

getDeviceState(deviceId: number)

Params:

  • deviceId (number) - device id from getBuildings() or getDevices() response

Returns: Promise<DaichiDevice>

controlDevice(deviceId: number, functionId: number, val: number | boolean)

Params:

  • deviceId (number) - device id from getBuildings() or getDevices() response
  • functionId (number) - function id, every device has list of functions. Functions may be uniq from model to model. So check your device response for function ids.
  • val (number | boolean) - value, can be boolean for isOn functions (modes, on/off, start/stop slides, etc) or can be a number (temperature, fan speed, etc)

Returns: Promise<DaichiControl>

getMqttUserInfo()

Returns: Promise<MqttUser>

  • id (number) - userId to listen user topics
  • username (string) - mqtt username
  • password (string) - mqtt password

Example usage with mqtt package.

const mqttUser = await daichi.getMqttUserInfo()

const mqtt = connect('wss://split.daichicloud.ru/mqtt', {
  username: mqttUser.username,
  password: mqttUser.password
})
mqtt.on('message', (topic, message) => {
  console.log(topic, message.toString())
})
mqtt.subscribe(`user/${mqttUser.id}/#`, (err, granted) => {
  if (err) console.error(err)
  else console.log(granted)
})

Daichi cloud MQTT topics

Currently discovered topics are:

  • user/${mqttUser.id}/notification
  • user/${mqttUser.id}/pre-notification
  • user/${mqttUser.id}/out/control/commands/status

For notification and pre-notification you can use Zod schemas: Example:

import { DaichiMqttNotificationSchema } from 'daichi'

function onNotification(message: string) {
  return DaichiMqttNotificationSchema.parse(JSON.parse(message))
}

Troubleshoot

For troubleshooting use env DEBUG=daichi for verbose loggings.