【Java】Dysonの家電をプログラム経由で操作したり室温を取得したりする

2020年12月31日

今回はDysonの空調家電、Pure Hot + Cool LinkをJavaから操作してみましょう。

テストに使う型番はHP03ですが他のDyson扇風機や加湿器などでも同じように操作できると予想されますので参考にしてみてください。

プログラムを実行する前にDyson家電をセットアップしておきましょう。
セットアップは前回の記事で紹介しています。

HP03はMQTTというプロトコルを使用します。
ライブラリを使えば楽なのですが、MQTTについて少しでも理解を深めたいので、あえて標準ライブラリのSocketクラスでセンサーデータ取得や操作を行います。

操作するためにはID、パスワードなどの情報が必要です。情報取得のためのツールは前回の記事で紹介しています。

準備ができたら処理を実行してみましょう。

やってることの流れ

・認証
・subscribeリクエスト（受信登録）
・publishリクエスト（家電操作やセンサー情報取得要求）

です。

プログラムはこんな感じになりました。

  1. import java.io.IOException;
  2. import java.io.UnsupportedEncodingException;
  3. import java.net.InetSocketAddress;
  4. import java.nio.ByteBuffer;
  5. import java.nio.channels.SocketChannel;
  6. import java.nio.charset.StandardCharsets;
  7.  
  8. public class DysonTest {
  9. 	private static String clientId="test_001";//client idは自分で適当に設定しても動きます
  10. 	private static String userName="ユーザー名";//パケットキャプチャで解析が必要
  11. 	private static String password="パスワード";//パケットキャプチャで解析が必要
  12. 	private static String model="モデル番号";//パケットキャプチャで解析が必要(HP03は455)
  13. 	private static String host="IPアドレス";//ルータなどにアクセスして調べる
  14. 	private static int port=1883;//恐らく1883で問題なし
  15.  
  16. 	public static void main(String[] args) throws InterruptedException {
  17.  
  18. 		try (SocketChannel sock = SocketChannel.open(new InetSocketAddress(host, port))){
  19.  
  20. 			//データ受信スレッド起動
  21. 			new Thread(()->{
  22. 				try {
  23. 					receive(sock);
  24. 				} catch (IOException e) {
  25. 				} catch (InterruptedException e) {
  26. 				}
  27. 			}).start();
  28.  
  29. 			//認証データを送信
  30. 			sendAuthMsg(sock);
  31.  
  32. 			Thread.sleep(500);
  33.  
  34. 			//データ取得出来るようにするsubscribeリクエスト
  35. 			sendSubscribeMsg(sock);
  36.  
  37. 			Thread.sleep(500);
  38.  
  39. 			//現在のセンサーなどのデータをこちらに送りつけるように指示する
  40. 			sendCurrentStatusGetMsg(sock,(short)2);
  41.  
  42. 			Thread.sleep(500);
  43.  
  44. 			//電源をつける
  45. 			sendCtrlMsg(sock, "{\"fmod\": \"FAN\"}", (short)3);
  46.  
  47. 			Thread.sleep(3000);
  48.  
  49. 			//首振りON
  50. 			sendCtrlMsg(sock, "{\"oson\": \"ON\"}", (short)4);
  51.  
  52. 			Thread.sleep(3000);
  53.  
  54. 			//風量を最小に
  55. 			sendCtrlMsg(sock, "{\"fnsp\": \"0001\"}", (short)5);
  56.  
  57. 			Thread.sleep(3000);
  58.  
  59. 			//暖房ON
  60. 			sendCtrlMsg(sock, "{\"hmod\": \"HEAT\"}", (short)6);
  61.  
  62. 			Thread.sleep(3000);
  63.  
  64. 			//暖房OFF
  65. 			sendCtrlMsg(sock, "{\"hmod\": \"OFF\"}", (short)7);
  66.  
  67. 			Thread.sleep(3000);
  68.  
  69. 			//風量を最大に
  70. 			sendCtrlMsg(sock, "{\"fnsp\": \"0010\"}", (short)8);
  71.  
  72. 			Thread.sleep(3000);
  73.  
  74. 			//首振りOFF
  75. 			sendCtrlMsg(sock, "{\"oson\": \"OFF\"}", (short)9);
  76.  
  77. 			Thread.sleep(3000);
  78.  
  79. 			//電源を消す
  80. 			sendCtrlMsg(sock, "{\"fmod\": \"OFF\"}", (short)10);
  81.  
  82. 			Thread.sleep(3000);
  83. 		} catch (IOException e) {
  84. 			e.printStackTrace();
  85. 		}
  86. 	}
  87. 	private static void sendCtrlMsg(SocketChannel sock, String ctrlJson, short indentifer) throws IOException {
  88.  
  89. 		ByteBuffer result = ByteBuffer.allocate(1024);
  90.  
  91. 		//ヘッダー
  92. 		result.put((byte)0x32);
  93.  
  94. 		//データ
  95. 		ByteBuffer data = ByteBuffer.allocate(1024);
  96.  
  97. 		String topic = model+"/"+userName+"/command";
  98.  
  99. 		//Topic サイズ
  100. 		data.putShort((short)topic.length());
  101.  
  102. 		//Topic
  103. 		data.put(topic.getBytes("UTF-8"));
  104.  
  105. 		//Identifier
  106. 		data.putShort((short)indentifer);
  107.  
  108. 		//データ取得リクエストJSON
  109. 		String json = "{\"data\": "+ctrlJson+",\"mode-reason\": \"iot\",\"time\": \"2020-05-17T12:21:14Z\",\"msg\":\"STATE-SET\"}";
  110. 		data.put(json.getBytes("UTF-8"));
  111.  
  112. 		//サイズ計算
  113. 		putSize(data, result);
  114.  
  115. 		data.flip();
  116.  
  117. 		result.put(data);
  118.  
  119. 		result.flip();
  120.  
  121. 		//データの送信
  122. 		sock.write(result);
  123. 	}
  124.  
  125. 	//データ取得リクエスト
  126. 	private static void sendCurrentStatusGetMsg(SocketChannel sock, short indentifer) throws IOException {
  127.  
  128. 		ByteBuffer result = ByteBuffer.allocate(1024);
  129.  
  130. 		//ヘッダー
  131. 		result.put((byte)0x32);
  132.  
  133. 		//データ
  134. 		ByteBuffer data = ByteBuffer.allocate(1024);
  135.  
  136. 		String topic = model+"/"+userName+"/command";
  137.  
  138. 		//Topic サイズ
  139. 		data.putShort((short)topic.length());
  140.  
  141. 		//Topic
  142. 		data.put(topic.getBytes("UTF-8"));
  143.  
  144. 		//Identifier
  145. 		data.putShort((short)indentifer);
  146.  
  147. 		//データ取得リクエストJSON
  148. 		String json = "{\"mode-reason\":\"iot\",\"time\":\"2020-05-17T20:21:33Z\",\"msg\":\"REQUEST-CURRENT-STATE\"}";
  149. 		data.put(json.getBytes("UTF-8"));
  150.  
  151. 		//サイズ計算
  152. 		putSize(data, result);
  153.  
  154. 		data.flip();
  155.  
  156. 		result.put(data);
  157.  
  158. 		result.flip();
  159.  
  160. 		//データの送信
  161. 		sock.write(result);
  162. 	}
  163.  
  164. 	//データ取得できるようにするリクエスト
  165. 	private static void sendSubscribeMsg(SocketChannel sock) throws IOException {
  166.  
  167. 		ByteBuffer result = ByteBuffer.allocate(1024);
  168.  
  169. 		//ヘッダー
  170. 		result.put((byte)0x82);
  171.  
  172. 		//データ
  173. 		ByteBuffer data = ByteBuffer.allocate(1024);
  174.  
  175. 		//Identifier
  176. 		data.putShort((short)0x0001);
  177.  
  178.  
  179. 		String topic = model+"/"+userName+"/status/current";
  180.  
  181. 		//Topic サイズ
  182. 		data.putShort((short)topic.length());
  183.  
  184. 		//Topic
  185. 		data.put(topic.getBytes("UTF-8"));
  186.  
  187. 		//Requested QoS
  188. 		data.put((byte)0x01);
  189.  
  190. 		//サイズ計算
  191. 		putSize(data, result);
  192.  
  193. 		data.flip();
  194.  
  195. 		result.put(data);
  196.  
  197. 		result.flip();
  198.  
  199. 		//データの送信
  200. 		sock.write(result);
  201. 	}
  202.  
  203. 	//認証
  204. 	private static void sendAuthMsg(SocketChannel sock) throws IOException {
  205.  
  206. 		ByteBuffer result = ByteBuffer.allocate(1024);
  207.  
  208. 		//ヘッダー
  209. 		result.put((byte)0x10);
  210.  
  211. 		//データ
  212. 		ByteBuffer data = ByteBuffer.allocate(1024);
  213.  
  214. 		//プロトコル名サイズ
  215. 		data.putShort((short)0x0004);
  216.  
  217. 		//プロトコル名(MQTT)
  218. 		data.putInt(0x4d515454);
  219.  
  220. 		//MQTTバージョンv3.1.1
  221. 		data.put((byte)0x04);
  222.  
  223. 		//Connect Flags
  224. 		data.put((byte)0xc2);
  225.  
  226. 		//KeepAlive
  227. 		data.putShort((short)0x003c);
  228.  
  229. 		//クライアントID Length
  230. 		data.putShort((short)clientId.length());
  231.  
  232. 		//クライアントID
  233. 		data.put(clientId.getBytes("UTF-8"));
  234.  
  235. 		//ユーザー名 サイズ
  236. 		data.putShort((short)userName.length());
  237.  
  238. 		//ユーザー名
  239. 		data.put(userName.getBytes("UTF-8"));
  240.  
  241. 		//パスワード サイズ
  242. 		data.putShort((short)password.length());
  243.  
  244. 		//パスワード
  245. 		data.put(password.getBytes("UTF-8"));
  246.  
  247. 		//サイズ計算
  248. 		putSize(data, result);
  249.  
  250. 		data.flip();
  251.  
  252. 		result.put(data);
  253.  
  254. 		result.flip();
  255.  
  256. 		//データの送信
  257. 		sock.write(result);
  258. 	}
  259.  
  260. 	//ヘッダ以外のサイズ計算
  261. 	private static void putSize(ByteBuffer src, ByteBuffer dest){
  262.  
  263. 		int x = src.position();
  264. 		int digit = 0;
  265.  
  266. 		do {
  267. 			digit = x % 128;
  268. 			x = x / 128;
  269. 			if (x > 0) digit = digit | 0x80;
  270. 			dest.put((byte)(digit&0x000000ff));
  271. 		}while(x>0);
  272. 	}
  273.  
  274. 	//データ受信
  275. 	private static void receive(SocketChannel in) throws IOException, InterruptedException {
  276. 		ByteBuffer readData = ByteBuffer.allocate(4096);
  277. 		while(true) {
  278. 			readData.clear();
  279. 			int r = in.read(readData);
  280. 			readData.flip();
  281. 			if ( r == -1 ) {
  282. 				System.out.println("connection end.");
  283. 				break;
  284. 			}
  285. 			if ( (readData.get(0) & 0x30) == 0x30 ) {
  286. 				//dysonからのメッセージ受信
  287. 				//本当はレスポンスを返すべき
  288. 			}
  289. 			printByte(readData);
  290. 		}
  291. 	}
  292.  
  293. 	//データの表示
  294. 	private static void printByte(ByteBuffer bb) throws UnsupportedEncodingException {
  295. 		System.out.println("--------------------------------------");
  296. 		for ( int i = 0;i < bb.limit();i++ ) {
  297. 			byte b = bb.get(i);
  298. 			String ss = Integer.toHexString(Byte.toUnsignedInt(b)).toUpperCase();
  299. 			if ( ss.length() < 2 ) ss ="0"+ss;
  300. 			System.out.print("0x"+ss+",");
  301. 		}
  302. 		System.out.println();
  303. 		System.out.println(StandardCharsets.UTF_8.decode(bb));
  304. 		System.out.println("--------------------------------------");
  305. 	}
  306. }
  307.  
実行結果

実行結果(コンソール一部)

{“msg”:”ENVIRONMENTAL-CURRENT-SENSOR-DATA”,”time”:”2020-06-22T13:07:02.001Z”,”data”:{“tact”:”OFF”,”hact”:”OFF”,”pact”:”0003″,”vact”:”0001″,”sltm”:”OFF”}}

プログラム内には適当にコメント入れておいたので、MQTTの動きをちょっとでも理解したい場合は、参考にしてみてください。

その他、私が調べたパラメータ情報を載せておきます。

操作時の送信パラメータ情報

設定名 設定値 説明
fmod FAN,OFF,AUTO ファンのオンオフ制御
hmod HEAT,OFF 暖房機能のオンオフ
hmax 設定温度=(摂氏温度+273)*10 暖房機能の設定温度
fnsp 0001～0010 ファンの速度
oson ON,OFF 首振り
ffoc ON,OFF ディフューズドモード
nmod ON,OFF ナイトモード
sltm [分単位の数値],OFF スリープタイマー

センサーデータ取得時のパラメータ情報

センサー名 説明
tact 室温([(摂氏温度+273)*10]を表す数値)
hact 湿度
pact 空気汚染レベル（低いほどきれい）

これで、MQTTについて少しは理解できたかなぁ。。。

IoT, Java

Posted by nompor