wIoT-old

12 KiB

Raw Blame History

wIoT for NodeJS

适用于NodeJS的wIoT服务器控制组件，轻松物联

先觉条件

拥有烧录好wIoT固件的D1 MINI单片机
一台或多台无线WiFi路由器2.4G/5G
局域网内拥有一台装有NodeJS的服务器或电脑 (NodeJS装法非常简单, 请自行Google或百度)
配置好npm

快速开始

单片机接入

使用MicroUSB, 5V, 或3V pin脚给单片机供电
用一根导线连接D0脚与3V3脚，持续一秒以上拔出，以重置单片机
用手机或电脑搜索它的WiFi热点，名称格式wiot-xx:xx:xx:xx:xx:xx
连接上此热点，密码为1234567890
用浏览器打开网址http://192.168.0.1，记录网页中的MAC地址，这将用于识别此单片机
配置你无线路由器的ssid(即wifi名称，注意不能有非ASCII字符，比如汉字)和密码
配置完成后热点将自动断开，单片机将连接到你的无线路由器

依赖安装

在你的项目文件夹下打开命令行，输入以下指令安装wiot:

$ npm install wiot

使用方法

在你的项目文件夹中新建一个app.js文件，输入以下内容：

var wiot = require('wiot'); //引入wiot依赖包

// 新建一个单片机对象
// 这里使用了两个参数，MAC是单片机的MAC地址，pin中指定需要OUTPUT输出的端口
// 请自行修改MAC地址的值
var MyMCU = new wiot.client({MAC: "xx:xx:xx:xx:xx:xx", pin: {D4: wiot.OUTPUT}});


// 以下代码将实现，板载led亮1秒，灭1秒的循环

// 等待所有单品即准备就绪
wiot.begin([MyMCU], ()=>{ // 第一个参数为要等待的单片机对象数组，第二个参数为要执行的函数
    // 设置计时器，每隔2000毫秒, MyMCU的3号pin口将拉高一次电平
    setInterval(()=>{
        MyMCU.write(wiot.D4, wiot.HIGH);
    }, 2000);

    // 设置计时器，延时1000毫秒后开始执行大括号中指令
    setTimeout(()=>{
        // 设置计时器，每隔2000毫秒，MyMCU的3号pin口将拉低一次电平
        setInterval(()=>{
            MyMCU.write(wiot.D4, wiot.LOW);
        }, 2000);
    }, 1000);
});

开始执行

在项目文件夹中打开命令行，输入以下指令:

node app.js

预期结果

如果一切顺利，你现在应该会发现你的板载led在闪烁了

进阶设置

wiot.client

参数说明

名称	默认值	描述
MAC	""	单片机的MAC地址
pin	{D1: 0, D2: 0, D3: 0, D4: 0, D5: 0, D6: 0, D7: 0, D8: 0}	pin脚的模式, 0为INPUT, 1为OUTPUT, 2为INPUT_PULLUP
hint	true	是否显示状态提示
debug	false	是否开启debug模式
ip	"default"	指定单片机IP, 请在长时间搜索不到IP时尝试此选项
port	8848	Client的TCP Socket通信端口，默认8848
ip_range	"192.168.0"	IP搜索字段，请在长时间搜索不到IP时尝试此选项
localIP	"127.0.0.1"	本机IP
errDelayTime	2000	遇到网络错误时重试间隔时间(毫秒)
okDelayTime	30	收到网络请求后延时等待时间(毫秒)
resetDelayTime	4500	向单片机发送重置指令后多久不再发送新消息(毫秒)
noTryMaxTime	15000	经过此时间单片机仍未响应则重新发送消息(毫秒)
IntervalTime	2000	监听行为心跳间隔
MaxToReScanTime	180000	经过此事件单片机无响应则从新扫描IP地址(毫秒)
MinResearchTime	5000	搜索IP经过一此轮询后间隔时间(毫秒)
IpScanTimeout	1	IP扫描时的Ping检测超时时间(秒)
pingTimeout	2	心跳Ping检测的超时时间(秒)
MaxTraceBackTimes	8	判断连接状态所向前追溯的历史心跳个数

例如：

var MyMCU = new wiot.client({
    MAC: "xx:xx:xx:xx:xx:xx",
    pin: {
        D1: 0,
        D2: 0,
        D3: 1,
        D4: 1,
        D5: 0,
        D6: 1,
        D7: 0,
        D8: 0
    },
    hint: true,
    debug: false,
    ip: "192.168.0.55",
    port: 6666,
    ip_range: "192.168.0",
    localIP: "127.0.0.1",
    errDelayTime: 2000,
    okDelayTime: 30,
    resetDelayTime: 4500,
    noTryMaxTime: 15000,
    IntervalTime: 2000,
    MaxToReScanTime: 180000,
    MinResearchTime: 5000,
    IpScanTimeOut: 1,
    pingTimeout: 2,
    MaxTraceBackTimes: 8
});

事件绑定

.on(event, handler)

client事件列表

begin 开始于单片机正常交互
disConnected 与单片机断开连接
reConnected 与单片机恢复连接

var MCU = new wiot.client({"MAC": "xx:xx:xx:xx:xx:xx"});

MCU.on('disConnected', function () {
    // 当与MCU失联时会执行此处指令
    console.log('Disconnected with MCU!!');
});

.pinOn(pin, event, handler)

pin事件列表

on pin口电位从低到高
off pin口电位从高到低
change pin口电位变化

var MCU = new wiot.client({"MAC": "xx:xx:xx:xx:xx:xx"});

MCU.pinOn(wiot.D2, 'on', function () {
    // 当MCU的D2电位由低到高时会执行
    console.log('D2 from LOW to HIGH!!');
});

API

wiot.begin(): 单片机准备完成后开始执行

MCU0 = new wiot.client({MAC: "xx:xx:xx:xx:xx:xx", pin: {D4: wiot.OUTPUT}});
MCU1 = new wiot.client({MAC: "xx:xx:xx:xx:xx:ww"});

wiot.begin([MCU0, MCU1], ()=>{
    //这里放你要执行的指令
    //这些指令将会在MCU0和MCU1准备就绪后开始执行
});

wiot.loop(): 循环执行的指令，适合于条件控制语句

MCU0 = new wiot.client({MAC: "xx:xx:xx:xx:xx:xx", pin: {D4: wiot.OUTPUT}});
MCU1 = new wiot.client({MAC: "xx:xx:xx:xx:xx:ww"});

// 以下代码将实现: 当MCU0的D5接收到HIGH，MCU1的D4将会输出HIGH
//                当MCU0的D5接收到LOW, MCU1的D4将会输出LOW
// 本函数接受两个参数: 第一个是MCU对象数组, 第二个是参数为MCU对象数组的函数
wiot.loop([MCU0, MCU1], () => {
    if(MCU1.read(wiot.D5) == wiot.HIGH){
        MCU0.write(wiot.D4, wiot.HIGH);
    }else{
        MCU0.write(wiot.D4, wiot.LOW);
    }
});

注册表

wiot.register.set(status1, status2, function): 向注册表中添加一条规则, status可以是值或函数，当status1==status2时会触发function。注册表的设计是为了方便协调各扩展模块的使用，详见下文扩展模块。
wiot.register.set(status, function): 你也可以传入两个函数，其中status的返回值是bool型，变为true时触发function

var myLED = wiot.led(MyMCU, wiot.D4);
var pir = wiot.pir(MyMCU, wiot.D2);

//注册一条规则，当pir探测到人时，myLED亮
wiot.register.set(pir.getStatus, wiot.HIGH, ()=>{
    myLED.set(wiot.HIGH);
});

//注册一条规则，当人离开时，myLED灭
wiot.register.set(()=>{
    return (wiot.LOW == pir.getStatus);
}, ()=>{
    myLED.clear();
});

传感器扩展模块

LED

wiot.led(MCU, pin): 声明一个led模块
wiot.led.getStatus(): 获取led状态
wiot.led.set(status, time = 0, isSmooth = false): 设置led状态，起始状态，中间状态，最终状态，周期
wiot.led.breath(period): 设置一个呼吸灯
wiot.led.clear(): 重置led

MCU0 = new wiot.client({MAC: "xx:xx:xx:xx:xx:xx", pin: {D4: wiot.OUTPUT}});

var myLED = wiot.led(MCU0, wiot.D4); //新建一个led对象，使用MCU0上的D4口

/* 如果myLED不亮，则点亮它 */
if(!myLED.getStatus()){
    myLED.set(wiot.HIGH);
}

/* 设置一个周期为2秒的呼吸灯 */
myLED.breath(2000);

/* 设置一个亮三秒，灭四秒的led */
myLED.set([wiot.HIGH, wiot.LOW], [3000, 4000]);

/* 设置一个呼1秒吸3秒的呼吸渐变灯 */
myLED.set([wiot.LOW, wiot.HIGH], [1000, 3000], true);

/* 自定义一个先半亮2秒再全亮3秒再熄灭2秒的led灯 */
myLED.set([100, wiot.HIGH, wiot.LOW], [2000, 3000, 2000]);

/* 熄灭led */
myLED.clear();

PIR 红外人体传感器

wiot.pir(MCU, pin): 声明一个PIR模块
wiot.pir.getStatus(): 获取PIR状态，返回值wiot.HIGH(有人)，wiot.LOW(无人)

事件触发器

wiot.pir.on(event, handler)

事件列表

detected 探测到人
undetected 人体移动出探测范围
change 状态改变，包括有人到无人和无人到有人

MCU0 = new wiot.client({MAC: "xx:xx:xx:xx:xx:xx"});

var myPIR = wiot.pir(MCU0, wiot.D2); //新建一个pir对象，使用MCU0上的D2口

/* 输出pir状态到控制台 */
console.log(myPIR.getStatus());

/* 当探测到人，打印 "Detected People!" 到控制台 */
myPIR.on("detected", ()=>{
    console.log("Detected People!");
});

/* 人移动出探测范围，打印 "No People!!" 到控制台 */
myPIR.on("undetected", ()=>{
    console.log("No People!!");
});

/* 当状态改变，执行指令 */
myPIR.on("change", ()=>{
    /* 你的指令 */
});

IR 红外循迹/障碍传感器

wiot.ir(MCU, pin): 声明一个IR模块，pin可以是模拟或数字端口
wiot.ir.getStatus(): 获取IR状态，返回值wiot.HIGH(有障碍)，wiot.LOW(无障碍)，或者0-1024数值(限模拟端口)

事件触发器

wiot.ir.on(event, handler)

事件列表

detected 探测到障碍
undetected 障碍消失
change 状态改变

MCU0 = new wiot.client({MAC: "xx:xx:xx:xx:xx:xx"});

var myIR = wiot.ir(MCU0, wiot.D2); //新建一个ir对象，使用MCU0上的D2口

/* 输出ir状态到控制台 */
console.log(myIR.getStatus());

/* 当探测到物体，打印 "Detected Object!" 到控制台 */
myIR.on("detected", ()=>{
    console.log("Detected Object!");
});

/* 物体移动出探测范围，打印 "No Object!!" 到控制台 */
myIR.on("undetected", ()=>{
    console.log("No Object!!");
});

/* 当状态改变，执行指令 */
myIR.on("change", ()=>{
    /* 你的指令 */
});

lightSensor 光敏传感器

wiot.lightSensor(MCU, pin): 声明一个lightSensor模块, pin可以是模拟或数字端口
wiot.lightSensor.getStatus(): 获取lightSensor状态，返回值wiot.HIGH(有光)，wiot.LOW(无光)，或者0-1024数值(限模拟端口)

事件触发器

wiot.light.on(event, handler)

事件列表

light 由暗到明
dark 由明到暗
change 状态改变

MCU0 = new wiot.client({MAC: "xx:xx:xx:xx:xx:xx"});

var myLightSensor = wiot.lightSensor(MCU0, wiot.D1); //新建一个pir对象，使用MCU0上的D2口

/* 输出LightSensor状态到控制台 */
console.log(mylightSensor.getStatus());

/* 当由暗到明，打印 "Light!!!" 到控制台 */
myLightSensor.on("light", ()=>{
    console.log("Light!");
});

/* 由明到暗，打印 "Dark!!" 到控制台 */
myLightSensor.on("dark", ()=>{
    console.log("Dark!!");
});

/* 当状态改变，执行指令 */
myLightSensor.on("change", ()=>{
    /* 你的指令 */
});

网络扩展模块

mail 邮件模块

使用本模块向指定邮箱发送邮件。自豪地引用Yimian API构建！

wiot.mail(to, from = "wIoT"): 声明一个mail模块，参数收件地址，发件人名称
wiot.mail.send(subject, body): 发送邮件，需传入主题，邮件内容

var mail = wiot.mail("i@iotcat.me", "wIoT Test");

mail.send("Test", "Test from wiot!!");

guguji 咕咕机模块

使用本模块向指定咕咕机发送消息。咕咕机是一款便携式私人打印机，详见官网。使用本模块需要在官网提前申请好自己的开发者ak, 详见这里。自豪地引用Yimian API构建！

wiot.guguji(ak, userID, memobirdID): 声明一个guguji模块，参数: 开发者ak, 用户id, 咕咕机id
wiot.guguji.send(msg): 发送消息，需传入待发送的消息

var gugu = wiot.guguji("9e55121803474371bfa25d20e554b31f", "832598", "b3ee06a8bd9b49e1");

gugu.print("This is from wIoT!!");

12 KiB Raw Blame History

wIoT for NodeJS

先觉条件

快速开始

单片机接入

依赖安装

使用方法

开始执行

预期结果

进阶设置

wiot.client

参数说明

事件绑定

API

注册表

传感器扩展模块

LED

PIR 红外人体传感器

事件触发器

IR 红外循迹/障碍传感器

事件触发器

lightSensor 光敏传感器

事件触发器

网络扩展模块

mail 邮件模块

guguji 咕咕机模块

12 KiB

Raw Blame History