IoT-Studio User Manual

Transcription

1 IoT-Studio User Manual Version: v1.04 Date: Dec Edited by NEXCOM

2 Table of Contents 1 IoT-Studio Installation Overview Install Generic IoT-Studio NISE 105/NISE 50C/NIFE 100/NIFE 200 with MoonIsland and Yocto NIO100/101 with MoonIsland and Yocto Raspberry Pi 1/2/Zero with Debian Edison with Yocto NISE 50C and Raspberry Pi 2 with Windows 10 IoT Core Using NEXCOM IoT-Studio Overview Getting started Nodes introduction More about nodes and use cases inject debug function http/http response template delay trigger comment modbus rtu (need to update) modbus tcp request file tail sqlite serial switch change range csv html json xml catch mqtt nio100-gpio/nife200-gpio nio100-diag/nife200-diag ZigBee sensor LinkIt Assist 2502 data node IoT-Studio Application example How to customize your nodes Use templates Start making customized node... 47

3 History Version Date Description V /12/18 First Release V /12/25 Append Raspberry Pi in section Append Raspberry Pi Zero in section 1.7. Support Yocto on NISE50C in section and section V /12/28 Add LinkIt Assist 2502 data node 1

4 1 IoT-Studio Installation 1.1 Overview This chapter will help you go through the installation procedures of IoT-Studio and have it running on each NEXCOM gateway device with different operating systems NEXCOM devices and supported OS: Devices MoonIsland Yocto IoT Core Debian (Linux) (Linux) (Windows 10) (Linux) NISE 105 NISE 50C NIFE 100 NIFE 200 NIO 100/ NIO 101 Raspberry Pi 0/1 Raspberry Pi 2 Edison 1.2 Install Generic IoT-Studio You have to install dependencies of IoT-Studio in Windows or Ubuntu, such as visual studio 2013(g++) and nodejs, prior to generic IoT-Studio installation. Then, execute commands to install IoT-Studio as below. # tar zxvf iotstudio generic.tar.gz # cd iotstudio # npm install --production # node IoTStudio.js 1.3 NISE 105/NISE 50C/NIFE 100/NIFE 200 with MoonIsland and Yocto For NISE 105/NISE 50C/NIFE 100/NIFE 200 devices, there is no installation procedures needed before using IoT-Studio. Please follow the steps below to get started. 2

5 1. Connect the gateway device to your PC with DVI/HDMI cable and USB keyboard, and then power up the gateway device. 2. When the OS is booting up, you need to press Alt+F4 to enter the terminal mode from GUI mode. 3. Use command ifconfig eth0 to get the device IP address. 4. Point a browser to the address Now, you should see a login prompt before entering the IoT-Studio UI. Please use admin/password for User Name and Password. 1.4 NIO100/101 with MoonIsland and Yocto For NIO100/101 devices, there is no installation procedures needed before using IoT-Studio. Please follow the steps below to get started. 1. The default IP address of Eth1 on NIO100/101 device has already been set to , so in order for you to connect the gateway device to your PC, please set a static IP address on your PC. 2. Connect the gateway device to your PC with network cable. 3. Point a browser to the address Now, you should see a login prompt before entering the IoT-Studio UI. Please use root/password for User Name and Password. 1.5 Raspberry Pi 1/2/Zero with Debian 1. Open a new terminal on your Raspberry Pi as below. 3

6 2. Download node.js tool and install it with the following commands. # wget # tar zcvf node-v4.2.2.tar.gz # cd node-v4.2.2 #./configure # make # sudo make install #node -v # v Download IoT-Studio and start it with the following commands. # cd # tar zxvf iotstudio rp2.tar.gz # cd iotstudio rp2 # node iotstudio.js 4. Make IoT-Studio run automatically at system start-up. # echo node /home/pi/iotstudio rp2/iotstudio.js > /etc/init.d/iotstudio # sudo update-rc.d -f iotstudio defaults 5. Once IoT-Studio is running, point a browser to the device, on which the IoT-Studio is running. One way to get the IP address of the device is to use the command below. # ifconfig eth0 6. Point a browser to the address Edison with Yocto # tar zxvf iotstudio edsion.tar.gz # cd iotstudio edison # node iotstudio.js 4

7 1.7 NISE 50C and Raspberry Pi 2 with Windows 10 IoT Core This section covers IoT-Studio installation procedures on NISE 50C and Raspberry Pi 2 devices with Windows 10 IoT Core OS. Requirements before installation are as follows: A PC with Windows 10 OS installed Network cable NEXCOM NISE 50C or Raspberry Pi 2 The following tools need to be downloaded and installed on your PC: NEXCOM IoT-Studio Free Download (IoT-studio-win.zip) - Download Visual Studio 2015 Community update 1 platform - Download Node.js tool (node-v x86.msi) - Download Node.js for Windows IoT (Node.js.Tools.for.Windows.IoT.1.3.exe) - Download Getting started Follow the steps below to install IoT-Studio. 1. Connect NISE 50C device to your PC with network cable. 2. Install Windows IoT Core Watcher on your PC by executing WindowsIoTCoreWatcher.exe file (IoT-Studio Free Download). Now, you should be able to see the information similar to the figure below if the connection between your PC and the device is well established. 3. Unzip the IoT-studio-win.zip, and then execute IoTStudio.sln. 4. In Visual Studio 2015, click on Debug IoT-Studio Project properties as shown below. 5

8 5. For NISE 50C: Choose Active (Debug) for Configuration and Active (x86) for Platform. In the Remote Machine field, fill in the IP address shown" in Windows IoT Core Watcher (step 2). For Raspberry Pi 2: Choose Active (Debug) for Configuration and Active (ARM) for Platform. In the Remote machine field, fill in the IP address shown in Windows IoT Core Watcher (step 2). 6

9 6. Click on Build Clean Solution Build Solution, and then click on Remote Machine to deploy the IoT-Studio project for IoT Core. 7. Point a browser to the address and you can see the NEXCOM IoT-Studio. 7

10 2 Using NEXCOM IoT-Studio 2.1 Overview This chapter covers the user interface introduction and the basic operation of NEXCOM IoT-Studio, followed by the function description of each node. 2.2 Getting started 1. When you first log in to NEXCOM IoT-Studio, you will see this page as shown below. # Description 1. Hold various node elements for user to choose from 2. Work space 3. Showing information of a specific node 4. Showing debug message when you are debugging a node 5. Deploy button to deploy your flow 6. Input port on this node to receive function from the connected node 7. The node title 8. Output port to deliver the function from this node to another node 9. The blue dot indicates changes on the node 2. The icons on the left are various nodes, which you can drag whatever you want onto a sheet in work space. Click the Info tab on the right and you will see the information of the node you select. 8

11 3. You can drag several nodes onto a sheet and make them a flow based on the functions. (The connected nodes and lines will make a flow) Please note, some of the nodes have both the input and output ports, while some of them only have one port by the nature of the node. 4. You can connect as many nodes as you want between start and end nodes. In addition, one output port can connect with many input nodes. After the connection is created, you can do the coding job with the flow. 5. Double click on the inject node, and an Edit dialogue pops up. Set the Payload to string hello and click OK. 9

12 6. Double click on the second node, and name it world. Add some functions to the node in the Function box as shown below and click OK. 7. Double click on the third node, and name it!!. Add some functions to the node in the Function box as shown below and click OK. 8. Then, click the button Deploy on the upper right side to deploy your flow. 10

13 9. When you see Successfully deployed message on the top, the deployment is complete. Click the button to the left of the inject node, and you will see the message in the debug tab. 10. You can share the codes by selecting your flow, and then choose Export from the menu on the upper right corner, either by copying the codes or exporting them to a file directly. 11. To import the codes, you can choose Import from the menu on the upper right corner and paste the codes to the clipboard or select a file to import. 11

14 2.3 Nodes introduction This chapter covers function description of each node in NEXCOM IoT-Studio Nodes function summary The table below lists out the function summary of each node, and more detail and usage will be described in detail in next chapter. Nodes Function summary Provides an input node for http requests, allowing the creation of simple web services. Creates a new message based on the provided template Introduces a delay into a flow or rate limits messages. Creates two messages on the output separated by a timeout whenever ANY message arrives on the input Simple comment block can write message memorandum about nodes or flow A Modbus request node sends the msg.payload to a Modbus tcp port and expects a response Provides a connection to an outbound serial port. [file in] reads the specified file and sends the content as msg.payload, and the filename as msg.filename. Writes msg.payload to the file specified. Allows basic access to a SQLite database. This node uses the db.all operation against the configured database Tails (watches for things to be added) to the configured file [serial in] Reads data from a local serial port. [serial out] Provides a connection to an outbound serial port. Pressing the button to the left of the node allows a message on a topic to be injected into the flow. The Debug node can be connected to the output of any node. 12

15 Nodes Function summary A simple function node to route messages based on its properties. A function block where you can write code to do more interesting things. A simple function node to remap numeric input values to another scale. Set, change or delete properties of a message. A function that parses the msg.payload to convert csv to/from a JavaScript object and place the result in the payload. Extracts elements from an html document held in msg.payload using a selector A function that parses the msg.payload to convert a JSON string to/from a JavaScript object, and place the result back into the payload. A function that parses the msg.payload to convert xml to/from a JavaScript object, and place the result in the payload. NEXCOM NIO100 input node. Generates a msg.payload with either a 0 or 1 depending on the state of the input pin. Requires the gpio command to work. Catch errors thrown by nodes on the same tab. MQTT input node. Connects to a broker and subscribes to the specified topic. Provide the Permit Join enable/disable and report the supported sensor response raw data. The supported sensors in below: 1. NR ZigBee Residential Photoelectric Smoke Detector 2. NR ZigBee Residential Combustible Gas Detector 3. NR ZigBee Wireless Glass Break Detector 4. NR ZigBee Wireless Air Temperature & Humidity Sensor 5. NR ZigBee Wireless PIR Motion Sensor w/ CR123A Battery 6. NR ZigBee Wireless Magnetic Read Switch Sensor for Door/Window Entry Warning Alarm 7. NR ZigBee Indoor Carbon Dioxide (CO2) Detector 8. NR ZigBee Indoor Carbon Monoxide (CO) Detector 9. NR Smart Meter Plug 13

16 Nodes Nodes Function summary LinkIt Assist 2502 data node. Connect to LinkIt Assist 2502 by udp to get the info includes that time, battery level, battery charging status, GPS, ADC and DIN data Nodes Supported Platform Generic NISE 50C NISE 105 NIFE 100 NIFE 200 NIO101 Raspberry Pi 2 Edison IoT-Studio MI Yocto Win10 Yocto MI Yocto MI Yocto MI Yocto MI Debian Win10 Yocto 14

17 Nodes Generic IoT-Studio NISE 50C NISE 105 NIFE 100 NIFE 200 NIO101 Raspberry Pi 2 Edison MI Yocto Win10 Yocto MI Yocto MI Yocto MI Yocto MI Debian Win10 Yocto * * * * * * * * * * * * Note: support this node, do not support this node, * supported but not include in image can install by manual NEXCOM customized nodes On top of the original nodes from Node-RED, NEXCOM provides more nodes for even more applications. Input nodes: modbus rtu: Provide a connection to an outbound serial port. modbus tcp: A Modbus request node - sends the msg.payload to a Modbus TCP port and expects a response. GPIO nodes: nio100-gpio: NEXCOM NIO100 input node. Generates a msg.payload with either a 0 or 1 depending on the state of the input pin. Require the gpio command to work. nife200-gpio: NEXCOM NIF200 input node. Generates a msg.payload with either a 0 or 1 depending on the state of the input pin. Require the gpio command to work. Diagnostic: Provides information of CPU and device. Function node: ZigBee sensor: Provides specific ZigBee sensor response raw data. 15

18 3 More about nodes and use cases 3.1 inject Function: Pressing the button to the left of the node allows a message on a topic to be injected into the flow. The default is to display timestamp, like this: This is mainly for test purposes. The payload defaults to the current time in milliseconds since 1970, but can also be set to a String or left blank. The repeat function allows the payload to be sent on the required schedule. The Fire once at start option actually waits a short interval before firing to give other nodes a chance to instantiate properly. Note: "Interval between times" and "at a specific time" uses cron. This means that 20 minutes will be at the next hour, 20 minutes past and 40 minutes past, not in 20 minutes time. If you want every 20 minutes from now, use the "interval" option. Note: All string input is escaped. To add a carriage return to a string you should use a following function. 3.2 debug Function: The Debug node can be connected to the output of any node. It can be used to display the output of any message property in the debug tab of the sidebar. The default is to display msg.payload, like this: Each message will also display the timestamp, msg.topic and the property chosen to output. The sidebar can be accessed under the options drop-down in the top right corner. 16

19 The button to the right of the node will toggle its output on and off so you can de-clutter the debug window. If the payload is an object or buffer it will be stringified first for display and indicate that by saying "(Object)" or "(Buffer)". Selecting any particular message will highlight (in red) the debug node that reported it. This is useful if you wire up multiple debug nodes. Optionally, it can show the complete msg object. In addition, any calls to node.warn or node.error will appear here. 3.3 function Function: A function block where you can write code to do more interesting things. The message is passed in as a JavaScript object called msg. By convention it will have a msg.payload property containing the body of the message. Please refer to section 2.2 for example of using inject, debug, and function nodes. 3.4 http/http response Function: Provides an input node for http requests, allowing the creation of simple web services. This node does not send any response to the http request. This should be done with a subsequent HTTP Response node. Example: Create a HTTP page showing Hello World! 1. Add http, template, and http response nodes to the work space and link them like this: 2. Edit http node Set url to /hello and click OK. 17

20 3. Edit template node Add <h1>hello World!</h1> in Template box and click OK. 4. You should see changes on the nodes as below. Now, deploy your flow. 5. Open a new tab with the address and you will see like this: 18

21 3.5 template Function: Creates a new message based on the provided template. Example: <See section 3.1 example> 3.6 delay Function: Introduces a delay into a flow or rate limits messages. Default delay time is 5 seconds and rate limit of 1 msg/second, but both can be configured. Example: Write a message Hello World!! and make it to delay for 5 seconds. 1. Add inject, function, and debug nodes to the work space and link them like this: 2. Edit inject node Set the Payload to string Hello World!! and click OK. 3. Deploy your flow and click the button to the left of the inject node, and you will see debug message after 5 seconds. 3.7 trigger Function: Creates two messages on the output separated by a timeout whenever ANY message arrives on the input. The two output states can be specified as the duration of the timer. Either output can be set to a value, or templated from the inbound message using mustache syntax. 19

22 The payload is {{payload}} Example: Set the original value to 1 and then changes the value to 0 in 3 seconds. 1. Add inject, trigger, and debug nodes to the work space and link them like this: 2. Double click on trigger node and set the time to 3 seconds. 3. Deploy your flow and click the button to the left of the inject node, and you will see two debug messages. First the value 1 and then the value 0 is shows up after 3 seconds, which means the value has been changed from 1 to 0 in 3 seconds. 3.8 comment Add simple description or documentation about nodes or flow, and anything you write in the body will be rendered in the info tab. 20

23 3.9 modbus rtu (need to update) 3.10 modbus tcp request Function: A Modbus request node sends the msg.payload to a Modbus tcp port and expects a response. Connects, sends the "request", reads the "response". It can either count a number of returned characters into a fixed buffer, match a specified character before returning, wait a fixed timeout from first reply and then return, or just sit and wait for data. The response will be output in msg.payload as a buffer, so you may want to.tostring() it. Example: Build a Modbus tcp server on PC with Modbus tcp request node 3.11 file (Write) Function: Writes msg.payload to the file specified, e.g. to create a log. The filename can be configured in the node, if left blank it should be set in an incoming message on msg.filename. A newline is added to every message. But this can be turned off if required, for example, to allow binary files to be written. (Read) Function: Reads the specified file and sends the content as msg.payload, and the filename as msg.filename. The filename can be configured in the node, if left blank it should be set in an incoming message on msg.filename. Example: Save a message to a file named hello on the gateway device and read the message from the file you just saved. 21

24 1. Add two inject nodes, file (write), file (read), and debug nodes to the work space and link them like this: 2. Edit inject node Set the Payload to string Hello World!!, which is the message you will save to the file, and click OK. 3. Edit file (write) node - In the Filename field, specify a file name which you would like to write the message into. - Select an action you want (append, overwrite, or delete file). - Give this node a name to be rendered on the flow, and click OK. 4. Edit file (read) node - In the Filename field, point to the name you just used for the file, hello in this 22

25 example. - Choose an output format (an utf8 string or a buffer). 5. Give this node a name to be rendered on the flow, and click OK. 6. Deploy your flow and click the buttons to the left of the two inject nodes, and you will see the debug message Hello World!! tail Function: Tails (watches for things to be added) to the configured file. Please note, this node works on Linux and Mac only, as it relies on the tail -F command. (not working on Windows filesystems) 3.13 sqlite Function: Allows basic access to a SQLite database. This node uses the db.all operation against the configured database. This does allow INSERTS, UPDATES and DELETES. By its very nature it is SQL injection. msg.topic must hold the query for the database, and the result is returned in msg.payload. msg.payload can contain an array of values to bind to the topic. 23

26 Typically the returned payload will be an array of the result rows, (or an error). Example: Use SQLite command to create a table user in testdb.db on the device and retrieve the data from user table. 1. Create a table user in the database testdb.db on the device with 3 records in it. 2. Add inject, function, sqlite, and debug nodes to the work space and link them like this: 3. Edit function node Add command msg.topic = select * from user; in Function box, and give this node a name retrieve data, then click OK. 4. Edit sqlite node In Database field, point to the database testdb.db, and give this node a name testdb, then click OK. 24

27 5. Deploy your flow and click the buttons to the left of the inject nodes, and you will see whatever data stored in the user table showing up in the debug tab serial (in) Function: Reads data from a local serial port. Can either - wait for a "split" character (default \n). Also accepts hex notation (0x0a). - wait for a timeout in milliseconds for the first character received. - wait to fill a fixed sized buffer. It then outputs msg.payload as either a UTF8 ASCII string or a binary Buffer object. If no split character is specified, or a timeout or buffer size of 0, then a stream of single characters is sent, again either as ASCII chars or size 1 binary buffers. Example: Use RS232 COM port to connect with a device or a PC. 1. Add serial (in) node to the work space and configure it as below, then click OK. 25

28 2. Deploy your flow and any message received will show up in the debug tab. (out) Function: Provides a connection to an outbound serial port. Only the msg.payload is sent. Optionally the new line character used to split the input can be appended to every message sent out to the serial port. Example: You should use RS232 COM port to connect with a device or a PC. 3. Add serial (out) node to the work space and configure it as below, then click OK. 26

29 4. Deploy your flow, and it will send messages to the target device switch Function: A simple function node to route messages based on its properties. When a message arrives, the selected property is evaluated against each of the defined rules. The message is then sent to the output of all rules that pass. Note: the otherwise rule applies as a "not any of" the rules preceding it. Example: Make a switch to determine if the message received is matching with the rule, go first route, otherwise go second route. 1. First, add inject, function, switch, and debug nodes to the work space and link them like this: 2. Edit the function node as below, and click OK. 27

30 3. Edit the switch node as below, and click OK. If the msg.payload is equal to 1st route, go first route; otherwise, go second route. Notice here, after you click OK, the switch node now has two ports for you to connect two routes. 4. Add another function and debug nodes to the work space and link them like this: 5. Edit the second function node as below, and click OK. 28

31 6. Deploy your flow and click the button to the left of the inject node, and you will see the debug messages. Now you can try to change the value in the first function node and see the result change Function: Set, change or delete properties of a message. The node can specify multiple rules that will be applied to the message in turn. The available operations are: Set - set a property. The to property can either be a string value, or reference another message property by name, for example: msg.topic. Change - search & replace parts of the property. If regular expressions are enabled, the replace with property can include capture groups, for example $1 Delete - delete a property 29

32 Example: Change a value message from 1 to Add inject, function, change, and debug nodes to the work space and link them like this: 2. Edit function node as below and click OK. 3. Edit change node as below and click OK. 4. Deploy your flow and click the button to the left of the inject node, and you should see value 2 showing in the debut tab. 30

33 3.17 range Function: A simple function node to remap numeric input values to another scale. Currently only does a linear scaling. Note: This only operates on numbers. Anything else will try to be made into a number and rejected if that fails. Scale and limit to target range means that the result will never be outside the range specified within the result range. Scale and wrap within the target range means that the result will essentially be a "modulo-style" wrap-around within the result range. Example: Map value 20 in the range of 10 to 50 to another value in the sale of 1 to Add inject, range, and debug nodes to the work space and link them like this: 2. Edit inject node as below and click OK. 3. Edit range node as below and click OK. 31

34 4. Deploy your flow and click the button to the left of the inject node, and you should see value 2 showing in the debut tab csv Function: A function that parses the msg.payload to convert csv to/from a JavaScript object and places the result in the payload. If the input is a string, it tries to parse it as CSV and creates a JavaScript object. If the input is a JavaScript object, it tries to build a CSV string. The columns template should contain an ordered list of column headers. For csv input, these become the property names. For csv output these specify the properties to extract from the object and the order for the csv. Example: Output the content of user.csv file as string messages. 1. The user.csv file on the device looks like this: 2. Add inject, file, csv, and debug nodes to the work space and link them like this: 32

35 3. Edit file node In Filename field, point to the csv file user.csv, and give this node a name user.csv, then click OK. 4. Edit csv node as below and click OK. 5. Deploy your flow and click the button to the left of the inject node, and you should see the debug messages. 33

36 3.19 html Function: Extracts elements from an html document held in msg.payload using a selector. The selector uses Cheerio which uses the CSS selector syntax. The result can be either a single message with a payload containing an array of the matched elements, or multiple messages that each contains a matched element json Function: A function that parses the msg.payload to convert a JSON string to/from a JavaScript object and place the result back into the payload. If the input is a JSON string it tries to parse it to a JavaScript object. If the input is a JavaScript object it creates a JSON string. Example: Output a string start and the JSON string. 1. Add inject, function, json, and two debug nodes to the work space and link them like this: 2. Edit the inject node as below and click OK. 34

37 3. Edit the function node by adding any JavaScript language you want and click OK. In this example, we add the following codes in the Function box: var filteredstores = []; for(var idx=0 ; idx < msg.payload.length ; idx++){ var currstore = msg.payload[idx]; if (currstore.state === context.global.specifiedstate){ filteredstores.push(currstore); } } msg.payload = filteredstores; 4. Deploy your flow and click the button to the left of the inject node, and you should see the debug messages xml Function: A function that parses the msg.payload to convert xml to/from a JavaScript object, and place the result in the payload. If the input is a string it tries to parse it as XML and creates a JavaScript object. If the input is a JavaScript object it tries to build an XML string. 35

38 Example: Generate an xml file for value A, B, and C. 1. Add 4 inject nodes, collector, xml, and debug nodes to the work space and link them like this: 2. After pressing the a, b and c inject buttons, the following XML is output in the debug tab: 3.22 catch Function: Catch errors thrown by nodes on the same tab. If a node throws an error whilst handling a message, the flow will typically halt. This node can be used to catch those errors and handle them with a dedicated flow. The node will catch errors thrown by any node on the same tab. If there are multiple catch nodes on a tab, they will all get triggered. If an error is thrown within a subflow, the error will get handled by any catch nodes within the subflow. If none exists, the error is propagated up to the tab the subflow instance is on. The message sent by this node will be the original message if the node that threw the error provided it. The message will have an error property with the following attributes: - message: the error message - source.id: the id of the node that threw the error - source.type: the type of the node that threw the error If the message already had an error property, it is copied to error. 36

39 Example: Use catch node to problematic nodes. 1. Add inject, function, catch, and two debug nodes to the work space and link them like this: 2. Edit inject node by setting Payload to be a string wrong and click OK. 3. Edit function node as below and click OK. Notice that there s an error in the code we made on purpose. 4. Deploy your flow and click the button to the left of the inject node, and you should see the debug as below. The message in red is the message which the catch node throws to indicate there s a problem with wrong node. 37

40 3.23 mqtt (in) Function: mqtt input node connects to a broker and subscribes to the specified topic. The topic may contain MQTT wildcards. Outputs an object called msg containing msg.topic, msg.payload, msg.qos and msg.retain. msg.payload is usually a string, but can also be a binary buffer. (out) Function: mqtt output node connects to a MQTT broker and publishes msg.payload either to the msg.topic or to the topic specified in the edit window. The value in the edit window has precedence. Likewise QoS and/or retain values in the edit panel will overwrite any msg.qos and msg.retain properties. If nothing is set they default to 0 and false respectively. If msg.payload contains an object it will be stringified before being sent. Example: 1. Set mqtt input node as below and click OK. 2. Set mqtt output node as below and click OK. 38

41 3. Inject value and see the debug message: 3.24 nio100-gpio/nife200-gpio Function: NEXCOM NIO100 input node. Generate an msg.payload with either a 0 or 1 depending on the state of the input pin. Require the gpio command to work. NEXCOM NIO100 output node. Expect an msg.payload with either a 0 or 1 (or true or false). Require the gpio command to work. It will set the selected physical pin high or low depending on the value passed in. The initial value of the pin at deploy time can also be set to 0 or 1. Example: 39

42 1. Edit inject node by setting Payload to be a string 1 and click OK. 2. Set nio100-gpio out node as below and click OK. 3. Deploy your flow and click on the button next to the inject node with value 0 to pass value to nio100-gpio out node. 4. Click the button next to the nio100-gpio input node and you will see the debug message: 3.25 nio100-diag/nife200-diag Function: NEXCOM NIO100 diagnosis node generates an msg.payload with the relative selected item. 40

43 Example: 1. Add inject, nio100-diag nodes, and debug nodes to your work space and link them like this: 2. Click on the button next to the inject node and you will see the debug message ZigBee sensor Function: ZigBee sensor node is configured to catch specific NR (Nietzsche Enterprise Co., Ltd), and outputs the sensor report data. The input will be triggered by inject node to enable permit join (refer to ZigBee specification) feature. Configuration: Serial Port: To use zigbee sensor node, you need to plug the NR gateway/coordinator (ex: WZB-01USB) USB dongle onto your board. There will be a virtual com with default setting as follows: baudrate:9600, data bits:8, parity:none and stop bits:1 41

44 Sensor: The current supported sensors are as follows: - NR ZigBee Residential Photoelectric Smoke Detector - NR ZigBee Residential Combustible Gas Detector - NR ZigBee Wireless Glass Break Detector - NR ZigBee Wireless Air Temperature & Humidity Sensor - NR ZigBee Wireless PIR Motion Sensor w/ CR123A Battery - NR ZigBee Wireless Magnetic Read Switch Sensor for Door/Window Entry Warning Alarm - NR ZigBee Indoor Carbon Dioxide (CO2) Detector - NR ZigBee Indoor Carbon Monoxide (CO) Detector - NR Smart Meter Plug Permit Join: Check this box to enable permit join feature when triggered by inject node. Example: 1. Add inject, zigbee sensor and debug nodes to the work space and link them like this. 2. Edit zigbee node by selecting the sensor NR ZigBee Wireless Air Temperature & Humidity Sensor from the drop-down list. 3. You will see a status icon connected underneath the zigbee node if your ZigBee coordinator is working well. 4. Check the permit join box, as the first ZigBee sensor needs to permit join. 5. Deploy your flow and click on the button next to the inject node. The coordinator will wait for 3 minutes for sensor to join. 6. After the sensor joins successfully, you will see the received sensor response raw data in the debug tab. 42

45 3.27 LinkIt Assist 2502 data node Function: LinkIt Assist 2502 data node node is configured to connect to LinkIt Assist 2502 board and retrieve information including time, battery level, battery charging status, GPS, ADC and DIN data. To work with IoT Studio, the LinkIt Assist 2502 board needs to be programmed as a sensor node. Please download the sensor node code from here, unzip the pack and read readme.txt, and also reference the MediaTek LinkIt Assist 2502 Developers Guide to program the board. Configuration: Because the LinkIt Assist 2502 sensor node will use Wi-Fi to connect to AP for access, so LinkIt Assist 2502 data node need to know the LinkIt Assist 2502 sensor node IP and port for udp connect. Example: 1. Add inject, LinkIt Assist 2502 data node and debug nodes to the work space and link them like below. 2. Edit LinkIt Assist 2502 data node node by set LinkIt Assist 2502 sensor node IP and port. 3. You will see a status icon output underneath the LinkIt Assist 2502 data node node if LinkIt Assist 2502 sensor node is connecting well. 4. Edit inject node the Payload is string and get value for LinkIt Assist

46 sensor node to get info. The other value will ignore. 5. Deploy your flow and click on the button next to the inject node. The LinkIt Assist 2502 sensor node will response info. 6. After the LinkIt Assist 2502 sensor node successfully response, you will see the received LinkIt Assist 2502 sensor node response raw data in the debug tab. 44

47 4 IoT-Studio Application example NEXCOM IoT-Studio practices application method by MQTT. With IoT-Studio, the information on the gateway will be published to the broker on cloud services, such as IBM Bluemix, Microsoft Azure, or Amazon AWS; end users can also subscribe the information out from the broker via mqtt easily, as shown below: Here is how we deploy all the necessary nodes on IoT-Studio for both the gateway side and end user side: Gateway side: Get information on the gateway and publish it to broker via mqtt. 45

48 End user side: Use mqtt node on IoT-Studio to subscribe the device information about CPU, RAM, and eth0 from broker on the cloud service. Point a browser to the address and you will see a Gateway List as below. Click the NIO100 GW-MI. Then, you will see the information about the gateway immediately. 46

49 5 How to customize your nodes This character will show you how to create a node by walking you through the process of making nio 100-gpio nodes and nife 200-gpio nodes. 5.1 Use templates In general, you will need html and js files to create a node. Find nodes folder, which contains all nodes used in IoT-Studio, under the IoT-Studio installed folder as shown below. You will find 99-sample.html.demo and 99-sample.js.demo files in the nodes folder, and we will use them as the template to make our node. The below section will show you how. 5.2 Start making customized node Make NIO 100 GPIO nodes 1. You need to know the NIO 100 GPIO specification before hands-on operation. NIO 100 has 8 GPIOs and the table below describes each port number and direction. GPIO Port Number Direction GPIO0 8 In GPIO1 9 In GPIO2 10 In GPIO3 11 In GPIO4 12 Out GPIO5 13 Out GPIO6 14 Out GPIO7 15 Out e.g. read from GPIO0 cat /sys/class/gpio/gpio8/value eg. write 1 to GPIO4 echo -n "1" > /sys/class/gpio/gpio12/value 47

50 2. Copy the 99-sample.html.demo and 99-sample.js.demo files and rename to 98-nio100-gpio.html and 98-nio100-gpio.js accordingly. 3. In the 98-nio100-gpio.html file, implement two nodes: nio-gpio in and nio-gpio out. Make nio-gpio in to have 4 options for GPIO Pin to select: DI0, DI1, DI2, and DI3; do the same for nio-gpio out, but the options will be DO0, DO1, DO2, and DO3. The partial codes in 98-nio100-gpio.html look like this: <div class="form-row"> <label for="node-input-pin"><i class="fa fa-circle"></i> GPIO Pin</label> <select type="text" id="node-input-pin" style="width: 250px;"> <option value='' disabled selected style='display:none;'>select pin</option> <option value="8">di0</option> <option value="9">di1</option> <option value="10">di2</option> <option value="11">di3</option> </select> <span id="pitype"></span> </div> <div class="form-row"> <label for="node-input-pin"><i class="fa fa-circle"></i> GPIO Pin</label> <select type="text" id="node-input-pin" style="width: 250px;"> <option value='' disabled selected style='display:none;'>select pin</option> <option value="12">do0</option> <option value="13">do1</option> <option value="14">do2</option> <option value="15">do3</option> </select> <span id="pitype"></span> </div> 4. Register the two nodes. RED.nodes.registerType('nio100-gpio in',{ category: 'NIO100', color:"#c6dbef", defaults: { name: { value:"" }, pin: { value:"",required:true,validate:red.validators.number() }, intype: { value: "in" }, read: { value:false } }, inputs:0, outputs:1, icon: "nexcom.png", RED.nodes.registerType('nio100-gpio out',{ category: 'NIO100', color:"#c6dbef", defaults: { name: { value:"" }, pin: { value:"",required:true,validate:red.validators.number() }, set: { value:"" }, level: { value:"0" }, 48

51 out: { value:"out" } }, inputs:1, outputs:0, icon: "nexcom.png", 5. In the IoT-Studio application, you will see the user interface of the two nodes as below: 6. In the 98-nio100-gpio.js, there is a function that spawns child processes to execute a shell script to call cat for input and echo for output, according to NIO 100 GPIO specification. The scrip is as below: while ([ $2 -eq "8" ] [ $2 -eq "9" ] [ $2 -eq "10" ] [ $2 -eq "11" ]) do echo cat /sys/class/gpio/gpio$2/value sleep 1 done if [ $2 -eq "12" ] [ $2 -eq "13" ] [ $2 -eq "14" ] [ $2 -eq "15" ]; then while read input; do echo -n "$input" > /sys/class/gpio/gpio$2/value done fi 7. You can refer to the NIO 100 image for the rest of the codes. Make NIFE 200 GPIO nodes 1. NIFE 200 GPIO pin information is described in the table below: Pin GPI/O Power On Address Pin GPI/O Power On Address No. Mode Default No. Mode Default 1 VCC GND GPO0 Low A03h (Bit6) 4 GPI0 High A03h (Bit1) 5 GPO1 Low A02h (Bit5) 6 GPI1 High A05h (Bit5) 7 GPO2 Low A07h (Bit0) 8 GPI2 High A05h (Bit4) 9 GPO3 Low A07h (Bit1) 10 GPI3 High A00h (Bit1) Control the GPO 0/1/2/3 level from I/O port A03h (Bit6)/ A02h (Bit5) /A07h (Bit0)/ A07h (Bit1) respectively. The bit Set (1) or Clear (0) indicates output High or Low. 49

52 2. The steps of making the user interface and the behavior of NIFE 200 GPIO nodes is the same as making NIO 100 GPIO nodes. (refer to steps 2~7 of Make NIO 100 GPIO nodes) Sample codes written in C: #define GPO0 (0x01 << 6) #define GPO1 (0x01 << 5) #define GPO2 (0x01 << 0) #define GPO3 (0x01 << 1) #define GPO0_HI outportb(0xa03, GPO0) #define GPO0_LO outportb(0xa03, 0x00) #define GPO1_HI outportb(0xa02, GPO1) #define GPO1_LO outportb(0xa02, 0x00) #define GPO2_HI outportb(0xa07, GPO2) #define GPO2_LO outportb(0xa07, 0x00) #define GPO3_HI outportb(0xa07, GPO3) #define GPO3_LO outportb(0xa07, 0x00) void main(void) { GPO0_HI; GPO1_LO; GPO2_HI; GPO3_LO; } 50