Noduino OpenLight

来自Jack's Lab
2017年5月3日 (三) 13:46Comcat (讨论 | 贡献)的版本

跳转到: 导航, 搜索

目录

1 Overview

OpenLight Bulb:

Openlight-bulb-1024.jpg

OpenLight Controller:

OpenLight-Controller-2.jpg Openlight-ctrl-demo.jpg


Noduino-works-with-logo.png



2 Quick Start

Maike-wifi-bulb-2955-all-en.jpg

  • Power on, waiting 8s to light
  • Light is flashing slowly in red means waiting for network connection
  • If the light is not flashing in red, please turn on and off 3 times, (eg. turn on - light on - turn off, 3 times) the light will be in red gradient for network connection
  • Connect mobile to Wifi then scan QR code in WeChat to click “Network Connection”
  • Enter WiFi password, click "Connect" then waiting for network connecting complete. (P.S. only 2.4G WiFi is applicable, 5G WiFi and WiFi enterprise-level security certifications are not applicable)
  • Complete WiFi configuration, WeChat will be in LAN devices discovery mode. Available devices list will be visible.
  • Click the first device then press "Link Device" button to bind the device. (P.S. if the device has been binding, then the button at bottom is "Enter Official Account")
  • Finish above steps, please press "Enter Official Account" button then click "My Device" button to find your binding devices list. Click the device to enter control page.


Openlight-wechat-ui.jpg


Note:
  • If more people need to control the device, please connect to the same router and scan the same QR code while the device is power on. Click "Device connected and skip" -> "Link Device"->"Enter Official Account" to control smart devices
  • To connect the device to another router in same network, please turn on and off the light 3 times and scan the QR code in Wechat to connect the network, binding is not necessary.
  • To transfer the device to different place(networks), the light will be in red gradient waiting for networks matching. To connect networks please just scan QR code in WeChat.
  • Turn on and off the light 6 times to restore the factory settings



3 Open API

Afer you guys 'Link Device' in WeChat, Enter Official Account:


  • click "Devices" to list your binding devices
  • select your OpenLight in the list, enter control page, click upright corner, then Copy URL
  • paste the URL into web browser (Chrome or Safari) to access the control page in browser
  • check the source code of the page to get the following variables:


var devid = YOUR_DEVICE_ID;
var mqtt_uname = xxxxxxxx;
var mqtt_pass = TTTTTTTTTTTTTTTT;                           < ---- 3600s life time
var mqtt_server = xxx.xxx.xxx.xxx;
var mqtt_port = xxx;



3.1 node.js

Prepare the node.js:

# download the node-v6.9.1-xxx.tgz from http://nodejs.org
$ tar xf node-v6.9.1-*.tar.xz
$ sudo cp -a node-v6.9.1*/*  /usr/local/
$ sudo npm install -g MQTTClient
$ sudo npm install -g request



3.1.1 Turn Off

Using the node.js to switch off the OpenLigh:

$ cat light-off.js
#! /usr/bin/env node

var opt = {
    username: "YOUR_mqtt_uname",
    password: ""
};
var http_req = require('/usr/local/lib/node_modules/request');
http_req.post(
	'http://apiiot.mjyun.com/vendor/user_login',
	{ json: {user_id: opt.username, app_id:"mj2030064278", app_key:"0077d4829f52b1b2d668f8a82c5f5ded"} },
	function (error, response, body) {
		if (!error && response.statusCode == 200) {
			console.log(body);

			opt.password = body.user_token;

			var MQTTClient = require('MQTTClient').Client;
			var client = new MQTTClient('101.200.241.60', 1883, opt);
			client.connect(function () {
				console.log("connect ok!");

				var pubopt = {
					qos_level:  2
				};

				var state = {
					on: 0          <---- off
				};
				var data = '{"m":"set", "d":{' + '"s":' + state.on + '}}';
				client.publish('app2dev/YOUR_DEVICE_ID', data, pubopt, function (message_id) {
					console.log("public ok! message_id = " + message_id);
					process.exit(0);
				});
			});
		} else {
			console.log("Request the user token failed");
			process.exit(1);
		}
	}
);

$ ./light-off.js



3.1.2 Turn On

Turn on the OpenLight:

$ cat light-on.js
#! /usr/bin/env node

var opt = {
    username: "YOUR_mqtt_uname",
    password: ""
};
var http_req = require('/usr/local/lib/node_modules/request');
http_req.post(
	'http://apiiot.mjyun.com/vendor/user_login',
	{ json: {user_id: opt.username, app_id:"mj2030064278", app_key:"0077d4829f52b1b2d668f8a82c5f5ded"} },
	function (error, response, body) {
		if (!error && response.statusCode == 200) {
			console.log(body);

			opt.password = body.user_token;

			var MQTTClient = require('MQTTClient').Client;
			var client = new MQTTClient('101.200.241.60', 1883, opt);
			client.connect(function () {
				console.log("connect ok!");

				var pubopt = {
					qos_level:  2
				};

				var state = {
					on: 1          <---- on
				};
				var data = '{"m":"set", "d":{' + '"s":' + state.on + '}}';
				client.publish('app2dev/YOUR_DEVICE_ID', data, pubopt, function (message_id) {
					console.log("public ok! message_id = " + message_id);
					process.exit(0);
				});
			});
		} else {
			console.log("Request the user token failed");
			process.exit(1);
		}
	}
);

$ ./light-on.js



3.1.3 Setup Color

Change the color of the OpenLight:

$ cat light-color.js
#! /usr/bin/env node

var opt = {
    username: "YOUR_mqtt_uname",
    password: ""
};

var http_req = require('/usr/local/lib/node_modules/request');
http_req.post(
	'http://apiiot.mjyun.com/vendor/user_login',
	{ json: {user_id: opt.username, app_id:"mj2030064278", app_key:"0077d4829f52b1b2d668f8a82c5f5ded"} },
	function (error, response, body) {
		if (!error && response.statusCode == 200) {
			console.log(body);

			opt.password = body.user_token;

			var MQTTClient = require('MQTTClient').Client;
			var client = new MQTTClient('101.200.241.60', 1883, opt);
			client.connect(function () {
				console.log("connect ok!");

				var pubopt = {
					qos_level:  2
				};

				var state = {
					red: 0,
					green: 0,
					blue: 255,     <--------- outputting full power of the blue channel
					white: 0,
					on: 1
				};

				data = '{"m":"set", "d":{' + '"r":' + state.red + ',"g":' + state.green
					       + ',"b":' + state.blue + ',"w":' + state.white
					       + ',"s":' + state.on + '}}';
				client.publish('app2dev/YOUR_DEVICE_ID', data, pubopt, function (message_id) {
					console.log("public ok! message_id = " + message_id);
					process.exit(0);
				});
			});
		} else {
			console.log("Request the user token failed");
			process.exit(1);
		}
	}
);

$ ./light-color.js



3.1.4 FAQ

If you get the following error:

/usr/local/lib/node_modules/MQTTClient/client.js:56
		throw Error('user names are kept to 12 characters or fewer');
		^

Error: user names are kept to 12 characters or fewer

Please patch the /usr/local/lib/node_modules/MQTTClient/client.js to remove the line of checking the length of username and password:

--- a/client.js
+++ b/client.js
@@ -52,10 +52,10 @@ var Client = exports.Client = function (host, port, options) {
                options.alive_timer = 30;
        options.ping_timer = parseInt(options.alive_timer * 0.6 * 1000);
        // 用户名和密码
-       if (typeof options.username == 'string' && options.username.length > 12)
-               throw Error('user names are kept to 12 characters or fewer');
-       if (typeof options.password == 'string' && options.password.length > 12)
-               throw Error('passwords are kept to 12 characters or fewer');
+       //if (typeof options.username == 'string' && options.username.length > 12)
+       //      throw Error('user names are kept to 12 characters or fewer');
+       //if (typeof options.password == 'string' && options.password.length > 12)
+       //      throw Error('passwords are kept to 12 characters or fewer');
        // Will flag
        if (options.will_flag && (typeof options.will_topic != 'string' || typeof options.will_message != 'string'))
                throw Error('missing will_topic or will_message when will_flag is set');



3.2 HTML5

The device control page in WeChat is a H5 page. Using a MQTT client implement in javascript , using the mqttws31.js library:

var client_id = parseInt(Math.random() * 10000, 10) + '_' + mqtt_uname;
var client = new Paho.MQTT.Client(mqtt_server, mqtt_port, "/mqtt", client_id);
function failConnect(e) {
	console.log("connect failed");
	console.log(e);
	console.log("reconnecting ...");
	client.connect({userName: mqtt_uname, password: mqtt_pass, onSuccess:onConnect, onFailure: failConnect, mqttVersion:3});
}
function onConnect() {
	console.log("onConnect OK!");
	subscribe('dev2app/' + devid);
}
function subscribe(topic) {
	client.subscribe(topic);
}
function onMessageArrived (message) {
	console.log("Arrived Message: [", message.payloadString, "]");
	try {
		job = JSON.parse(message.payloadString);
		set = job.d;
	} catch(e) {
		console.log("JSON object error!");
		alert("JSON error, RX data is: " + message.payloadString);
		return;
	}
	if(job.m == 'set' || job.m == 'status') {
		//console.log("set ui state");
		set_ui_state(set);
	}
	if(job.m == 'offline') {
		blockUI();
	}
}
function onDisConnect() {
	console.log("reconnecting ...");
	client.connect({userName: mqtt_uname, password: mqtt_pass, onSuccess:onConnect, onFailure: failConnect, mqttVersion:3});
}
function mqtt_publish(msg){
	var topic = 'app2dev/' + devid;
	message = new Paho.MQTT.Message(msg);
	message.destinationName = topic;
	client.send(message);
	console.log("publish message: " + msg);
}
function mqtt_init() {
	client.connect({userName: mqtt_uname, password: mqtt_pass, onSuccess:onConnect, onFailure: failConnect, mqttVersion:3});
	client.onMessageArrived = onMessageArrived;
	client.onConnectionLost = onDisConnect;
}
mqtt_init();



4 Open API (HTTP in LAN)

Note: the device security policy using the WiFi router's password, that is: the users who are authorized to connect to the WiFi router, is a trusted user

Device start a HTTP service by default. You can send the following HTTP request to turn on or turn off the device. This way independent of MQTT cloud service can be used in local area network when you don't want to make device access Internet.


4.1 Get the device IP

You can use the Fing app in iOS to scan the LAN network.

The device named Espressif is your OpenLight device:


Fing-lan-scan.png


4.2 Turn On via HTTP in LAN

192.168.1.75 is the OpenLight device IP

Turn On:

$ cat light-on.txt 

$ cat light-on.txt | nc 192.168.1.75 80
HTTP/1.0 200 OK
Server: lwIP/1.4.0
Content-type: text/plain
Content-Length: 0
Connection: close


4.3 Turn Off via HTTP in LAN

192.168.1.75 is the OpenLight device IP

Turn Off:

$ cat light-off.txt 

$ cat light-off.txt | nc 192.168.1.75 80
HTTP/1.0 200 OK
Server: lwIP/1.4.0
Content-type: text/plain
Content-Length: 0
Connection: close




5 HomeBridge

To use the Siri to control the OpenPlug :)



6 Alexa

Support Amazon Alexa:


6.1 Discover

Alexa-noduino-discove.png


You need to request echo to re-discover devices when you changed the voice name of the device in WeChat control page


6.2 Turn On/Off

Alexa-openlight-turnon.png


6.3 Set brightness

Alexa-openlight-brighten.png


Alexa-openlight-dim.png


Alexa-openlight-dim-num.png


Alexa-openlight-set.png




7 Firmware

7.1 Compile

Getting noduino-sdk:

$ git clone --recursive git://github.com/icamgo/noduino-sdk.git noduino-sdk


Generate toolchain (you need Python 2.7):

$ cd noduino-sdk/toolchain
$ ./gen.py

Compile:

$ cd ../sketch/open-light
$ make


The generated firmware is located in build/ dir named user1.bin annnd user2.bin


Window environment please refer to Getting Started with Noduino SDK on Windows, you can get how to setup the basic developmennt environment



7.2 Upload

7.2.1 Serial

Prepare a USB2UART board, something like FT232RL or CP2102/CP2104:

Ft232.jpg


Upload firmware throught serial for OpenLight Bulb:

Openlight-bulb-upload-serial-900.jpg]


Upload firmware throught serial for OpenLight Controller:

5pin.jpg


  • USB2UART_GND ------> SmartNode_GPIO0 / Bulb_GPIO0
  • USB2UAR_GND -----> SmartNode_GND / Bulb_GND
  • USB2UAR_RXD -----> SmartNode_TX / Bulb_TX
  • USB2UAR_TXD -----> SmartNode_RX / Bulb_TX


Connect USB2UAR_VCC3.3 -----> SmartNode_VCC / Bulb_3V3 at last

ESP8285 will be enter upload mode, we can upload the compiled firmware through serial using following commands in Linux:

$ cd /path/to/noduino-sdk/sketch/open-light
$ make produce ESPPORT=/dev/ttyUSB1


In windows:

$ make produce ESPPORT=COM7

COM7 is your USB2UART device


In MAC OS, maybe it's:

$ make produce ESPPORT=/dev/cu.SLAB_USBtoUART

/dev/cu.SLAB_USBtoUART is your USB2UART device



7.2.2 Online

Access
http://dev.noduino.org/openlight


Login
  • Username: noduino
  • password: noduino1234


Click the "Add files", select the user1.bin and user2.bin located in /path/to/noduino-sdk/sketch/open-light/build/


Then click "Start upload" to upload the user1.bin and user2.bin into the server temporaily


Enter Official Account, then click "Add" menu, enter "Debug" page

Maike-upload-online-1.jpg


Select your device and the input "ota" in the data aera then click "send data"


Maike-upload-online-2.jpg


Device will download your user1.bin or user2.bin and write it into flash when the device received the "ota" message

You will see the device online message in the Debug page when the uploading is finished




8 Hardware

8.1 Schemmatics

Noduino-open-light-v2.4-sch.png



8.2 LED

OpenLight MCPCB, LED lamp bead default layout:

  • Red LED 6 series,positive answer 12v, negative link control panel R (OUTA of MY9291)
  • Green LED 4 series, positive answer 12v, negative link control panel G (OUTB of MY9291)
  • Blue LED 4 series, positive answer 12v, negative link control panel B (OUTC of MY9291)
  • White LED*8 (4 series as a set, 2 groups parallel, positive answer 12v, negative link control panel W (OUTC of MY9291)


LED bead (5730) features:

  • Size 5.7 x 3.0 mm
  • Max current 150mA (0.5W)
  • VF is 3.0 - 3.4V (Red LED is 2.0 - 2.2V)
  • Brightness 50 - 55 lm


LED bead is just a diode, will light as long as there is a positive forward voltage(VF), 2-3.5V. The bead will not light if voltage below this range and will burn if above this range


Current control the bead brightness, so dimmer switch lamp actually switch the current. If current exceed the rated current that will speed up bead aging and shorten life



8.3 MY9291

OpenLight use the Taiwan Mingyang 4 - channel constant current LED driver ICS to control the R, G, B, w 4 LED lamp bead


Feature:
  • 3.3 - 5V power supply voltage range (±10%)
  • Each channel 5-350mA constant current output range
  • Maximum output voltage of 24V, support more than one LED in series
  • Few external components, only need four external groups to set the four constant - current


Block Diagrame:

MY9291.app.jpg


For constant voltage power source, can be cascaded, MCU control of two lines : DI & DCK


Power supply voltage and lamp bead series/parallel connection and to make sure
  • 12V Power supply, 4 LED beads shall be in series if the LED VF is 3V. 6 LED beads shall be in series if the LED VF is 2V
  • 24V Power supply, 8 LED beads shall be in series if the LED VF is 3V. 12 LED beads shall be in series if the LED VF is 2V
  • 6V Power supply, 2 LED beads shall be in series if the LED VF is 3V. 3 LED beads shall be in series if the LED VF is 2V


Output current

MY9291, maximum output of 350mA for single channel, in order to save life of lamp beads, can limit the maximum current through the lamp bead to save the life of lamp beads


Maximum output current limit:

 R = 380mV / Iout


Full output of 350mA, then each current resistance has to be selected as follows : 1R,1/4 w enough


OpenLight bulbs, R/G/B use 4R7 resistor, and current limit is about 81mA, W use parallel of 2.35R and two 4R7,current limit is about 162mA.This basically limit the current at around 80mA through each 5730 ( 0.5W ) lamp to delay aging of the lamp beads. Thus overall power is limited to 5W, if need to increase the brightness, the 5 4R7 resistor can be replaced by 3R0, also can increase the output power to 7W




9 Power

9.1 12V

220V switch to 12V constant voltage power supply model, rated 12W and 1A current output



9.2 3.3V

ESP8266/ESP8285 chip、MY9291/MY9231 chip、SPI Flash chip are all 3.3V power.

9.2.1 MP1470

  • Wide 4.7V to 16V Operating Input Range
  • Fixed 500kHz Switching Frequency
  • Over-Current Protection and Hiccup
  • Thermal Shutdown
  • Output Adjustable from 0.8V
  • Available in a 6-pin TSOT-23 package


Mp1470-typical.jpg



9.2.2 MP2359

  • Wide 4.5V to 24V Operating Input Range
  • 1.2A Peak Output Current
  • 0.35Ω Internal Power MOSFET Switch
  • Stable with Low ESR Output Ceramic Capacitors
  • Up to 92% Efficiency
  • 0.1μA Shutdown Mode
  • Fixed 1.4MHz Frequency
  • Thermal Shutdown
  • Cycle-by-Cycle Over Current Protection
  • Output Adjustable from 0.81V to 15V


Mp2359-sch.jpg




10 Reference

For more information please refer to























个人工具
名字空间

变换
操作
导航
工具箱