Tag Archives: esp8266

Development, Installation, Software

Micropython – Development tools Ampy – Eric

2018-05-29 admin

After the uPyCraft intallation in the previous article

MicroPython – IDE MicroPython uPyCraft

let’s now look at other tools available for the development in MicroPython for various platforms.

This article shows the operations to be performed on Windows and Linux.

First Python package to install is Ampy (Adafruit MicroPython Tool)

ampy

The tool is available in the python repositories, so it can be installed using the pip tool.

In Windos run in a dos command prompt

pip install adfruit-ampy

1	pip install adfruit-ampy

Similarly in Linux run in a shell

sudo pip3 install adafruit-ampy

1	sudo pip3 install adafruit-ampy

The available commands are listed running

ampy --help

1	ampy --help

Ampy allows the transfer, creation, viewing, and execution of files on the device.

As for the IDE you can install Eric, generic Python IDE

Eric

Eric does not allow communication from the IDE with the device as seen with uPyCraft; this task is delegated to Ampy. For the installation proceed as follows:

For Linux Debian 9 just run

sudo apt-get install eric

1	sudo apt-get install eric

The tool is available among the development tools; at the first execution it requires default settings

We define the workspace location

and we have the access to the IDE

For Windows download the zip

Eric

Unzip the zip into a folder from which we run it; install the prerequisites

pip install pyqt5-tools
pip install qscintilla

1 2	pip install pyqt5-tools pip install qscintilla

Perform the eric installation at this point by double clicking on install.py

The program checks the prerequisites and completes the installation

Clicking twice on eric6.py or running eric6 from a dos command prompt we run the program in the same way as seen for Linux Debian

In the next article we will briefly examine how a MicroPython program is structured

MicroPython – MicroPython program structure

Development, Installation, Software

Micropython – MicroPython IDE uPyCraft

2018-04-27 admin

After installing the firmware on the Nodemcu esp8266 DevKit board

MicroPython Firmware

let us now examine a development tool can be suitable for the development of Python code.

A tool that allows both to write code and upload it to the device is uPyCraft

uPyCraft

The tool currently works for Windows and from version 0.30 is also available for Linux; the source code is available at the link

uPyCraft Source

Here are the steps for Windows and Linux.

Windows

Once downloaded the package we must run it as an administrator; the installation of the Monaco font is required

After the font installation, we have the access to the IDE

We set the Location in Tools->Preferences->Language Location

and the serial port paramenters in Tools->Preferences->Serial

We plug the device into an USB port and set the serial port on uPyCraft

We choose the device type; in this case it is ESP8266

By clicking on the connection icon we access to the device and view the files on it

The firmware installation expands on the device only the Python file boot.py

The tool allows to download examples of MicroPython code for the board, blink.py for example

Clicking the “Download and Run” button we load the code onto the device and run it

In this example the led of the Nodemcu DevKit blinks.

Linux

The tool is similar in the Linux version; once downloaded the package to which we have to assign the execution right we run it. We must assign to the user the access to the serial port with the command, already seen above

sudo usermod -a -G dialout USER

1	sudo usermod -a -G dialout USER

In our case, on Debian 9, we have the following screens similar to what we saw on Windows.

In the uPyCraft IDE

We set the Location in Tools->Preferences->Language Location

and the serial port paramenters in Tools->Preferences->Serial

We plug the device into an USB port and set the serial port on uPyCraft

We choose the device type; in this case it is ESP8266

By clicking on the connection icon we access to the device and view the files on it

The firmware installation expands on the device only the Python file boot.py

The tool allows to download examples of MicroPython code for the board, blink.py for example

Clicking the “Download and Run” button we load the code onto the device and run it

As in Windows the led of the Nodemcu DevKit blinks..

In version 0.30 for Windows we noticed some bugs, so for this operating system we continue to use the uPyCraft version 0.29.

Further informations about uPyCraft can be found at the following site

uPyCraft Documentation

In the next article we will discuss another Python development tool

MicroPython – Development tools Ampy – Eric

Installation, Software

MicroPython – Python on embedded devices

2018-04-26 admin

In this article we begin to treat MicroPython

MicroPython

an implementation of Python3

Python

for embedded devices.

Various images are available on the MicroPython website for different devices, including the modules esp8266 and esp32

MicroPython Dowloads

We start our tests with a Nodemcu esp8266 DevKit

Nodemcu Devkit

We proceed to load the firmware on this card.

The Micropython site also refers how to load the firmware on the cards; these informations are available at the link

MicroPython Tutorial for esp8266

To load the firmware we always use the tool esptool, also available on the Python repository.

To be able to use it, we need to install Python3 on our development platform. Here are the steps to follow for Windows and Linux.

Windows

For windows we must first install the Python3 environment, available at the following link

Python for Windows

In our case, we downloaded the version 3.6.4 for 64-bit systems. We installed the package with administrative rights

After proceeding to add Python in the Path we click “Install Now”

After the installation, we open a dos command propmt and check the installed Python version

Always from the dos command prompt we proceed to the installation of esptool with the command

pip install esptool

1	pip install esptool

At this point we can proceed to the MicroPython firmware upload on the Nodemcu esp8266 DevKit. Of course, it is necessary to have the serial-ttl drivers installed for your DevKit model on Windows. Now go into the folder where the firmware has been downloaded and run the following commands from the dos command prompt

esptool.py --port COMPORT erase_flash

1	esptool.py --port COMPORT erase_flash

Proceed to load the firmware

esptool.py --port COMPORT --baud 460800 write_flash --flash_size=detect -fm=dio 0 firmware.bin

1	esptool.py --port COMPORT --baud 460800 write_flash --flash_size=detect -fm=dio 0 firmware.bin

Once the firmware is installed we log on the Python console using, in our case with the nodemcu card DevKit, the same port already used to load the firmware.

On Windows we can use Putty

Putty

and set the serial connection to 115200 baud rates

Linux

For Linux we use the Debian 9 distribution, but the procedure can be extended to other distributions. After installing Debian 9 , similar to version 8

Debian 8

we proceed to the installation of Python3 and esptool from a Linux shell

sudo apt-get install python3
sudo apt-get install python3-pip

1 2	sudo apt-get install python3 sudo apt-get install python3-pip

Add the user used on Debian to the dialout group

sudo usermod -a -G dialout USER

1	sudo usermod -a -G dialout USER

In our case, using sviluppo as a user, the command is as follows

sudo usermod -a -G dialout sviluppo

1	sudo usermod -a -G dialout sviluppo

Let’s move on to install the Python esptool package

sudo pip3 install esptool

1	sudo pip3 install esptool

We can then proceed with the installation of the firmware in the same way as done on Windows.

We check on which serial port the card is available (ttyUSBX)

We perform a flash erase and firmware upload

esptool.py --port /dev/ttyUSBX erase_flash

1	esptool.py --port /dev/ttyUSBX erase_flash

esptool.py --port /dev/ttyUSBX --baud 460800 write_flash --flash_size=detect -fm=dio 0 firmware.bin

1	esptool.py --port /dev/ttyUSBX --baud 460800 write_flash --flash_size=detect -fm=dio 0 firmware.bin

To log on the DevKit we use screen

sudo apt-get install screen

1	sudo apt-get install screen

Here is the manual of the tool

Screen Manual

screen /dev/ttyUSB0 115200

1	screen /dev/ttyUSB0 115200

To detach from screen press

Ctrl+a+d

Ctrl+a+d

instead to resume run

screen -r

screen -r

To quit screen

killall screen

1	killall screen

Once connected you get the same result as Windows

In the next article we will begin to see which IDEs can be used to create and load our Python code

MicroPython IDE uPyCraft

Configuration, Software

Mqtt with Beaglebone and ESP8266 – Articles List

2017-05-21 admin

Below is a list of the articles to follow to build your IOT environment consisting of sensors and relays with Beaglebone, ESP8266 and MQTT Mosquitto server.

Configuration, Software

Mqtt with Beaglebone and ESP8266 – Android Client

2017-05-05 admin

After Mosquitto server, ESP8266 nodes and Freeboard configuration

Mqtt with Beaglebone and ESP8266-Mosquitto installation on Beaglebone

MQTT with BeagleBone and ESP8266-MQTT ESP8266

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with temperature sensor

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with Relay

Mqtt with Beaglebone and ESP8266 – Freeboard

now we can proceed to use a Mqtt Client on an Android device.

In the Playstore various Mqtt applications are available

After the publishing and subscriber topics configuration in the Android client , analogous to what has been done for Freeboard widgets

Mqtt with Beaglebone and ESP8266 – Freeboard

it is possible to monitor the sensor temperature and humidity, the devices status and send commands to the relay (Turn On, Turn Off, Status, Restart, Sleep) and to the sensor (Restart, Sleep, Status).

Here is a screenshot with some subcriber topic and publisher topics of our installation using MQTT Dashboard

With the relay on

Configuration, Software

Mqtt with Beaglebone and ESP8266 – Freeboard

2017-04-22 admin

After the Mqtt web client installation

MQTT with Beaglebone and ESP8266 – WebServer and MQTT WebSocket

let’s install now the dashboard freeboard

Freeboard

In a ssh commad shell go into the /var/www/html folder on Beaglebone as root and clone the freeboard github respository; change the owner of the freeboard folder in www-data:www-data

#cd /var/www/html
#git clone https://github.com/Freeboard/freeboard.git freeboard
#chown www-data:www-data -R freeboard

#cd /var/www/html

#git clone https://github.com/Freeboard/freeboard.git freeboard

#chown www-data:www-data -R freeboard

With a web browser go to the freeboard folder on Beaglebone webserver to access the dashboard

We have to add now Freeboard additional plugins. We add the following

freeboard-mqtt

Clone the https://github.com/alsm/freeboard-mqtt github

#cd
#git clone https://github.com/alsm/freeboard-mqtt

1 2	#cd #git clone https://github.com/alsm/freeboard-mqtt

Download the mqtt paho javascript library

Paho mqtt javascript library

#cd
#git clone https://github.com/eclipse/paho.mqtt.javascript.git

1 2	#cd #git clone https://github.com/eclipse/paho.mqtt.javascript.git

Here is the direct link to the library

Last Version mqttws31.js

Create the mqtt folder under the Freeboard plugins folder and copy the mqttws31.js and paho.mqtt.plugin.js files

#cd /var/www/html/freeboard/plugins/mqtt
# ls
mqttws31.js  paho.mqtt.plugin.js

#cd /var/www/html/freeboard/plugins/mqtt

# ls

mqttws31.js paho.mqtt.plugin.js

Edit the paho.mqtt.plugin.js file and insert the reference to the mqttws31.js library in the external_scripts section; in this case too we have to change the folder and contents owner

// # A Freeboard Plugin that uses the Eclipse Paho javascript client to read MQTT messages

(function()
{
        // ### Datasource Definition
        //
        // -------------------
        freeboard.loadDatasourcePlugin({
                "type_name"   : "paho_mqtt",
                "display_name": "Paho MQTT",
        "description" : "Receive data from an MQTT server.",
                "external_scripts" : [
                        "plugins/mqtt/mqttws31.js"
                ],
                "settings"    : [

// # A Freeboard Plugin that uses the Eclipse Paho javascript client to read MQTT messages

(function()

{

// ### Datasource Definition

// -------------------

freeboard.loadDatasourcePlugin({

"type_name" : "paho_mqtt",

"display_name": "Paho MQTT",

"description" : "Receive data from an MQTT server.",

"external_scripts" : [

"plugins/mqtt/mqttws31.js"

"settings" : [

Change the owner

#cd /var/www/html/freeboard/plugins
#chown www-data:www-data -R mqtt

1 2	#cd /var/www/html/freeboard/plugins #chown www-data:www-data -R mqtt

Edit the /var/www/html/freeboard/index.html file and insert the reference to the paho.mqtt.plugin.js plugin in the heads.js section

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>freeboard</title>
        <meta name="mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-capable" content="yes" />
    <meta name="apple-mobile-web-app-status-bar-style" content="black" />
    <meta name="viewport" content = "width = device-width, initial-scale = 1, user-scalable = no" />
    <link href="css/freeboard.min.css" rel="stylesheet" />
    <script src="js/freeboard.thirdparty.min.js"></script>
    <script type="text/javascript">
        head.js("js/freeboard_plugins.min.js",
                "plugins/mqtt/paho.mqtt.plugin.js",
                // *** Load more plugins here ***
                function(){

<!DOCTYPE html>

<html>

<head>

<title>freeboard</title>

head.js("js/freeboard_plugins.min.js",

"plugins/mqtt/paho.mqtt.plugin.js",

// *** Load more plugins here ***

function(){

Add the dynamic-highcharts plugin

Clone in a folder the github

git clone https://github.com/onlinux/freeboard-dynamic-highcharts-plugin

1	git clone https://github.com/onlinux/freeboard-dynamic-highcharts-plugin

Copy the plugin_highcharts.js to the folder /var/www/html/plugins/thirdparty and change the owner

#cd /var/www/html/freeboard/plugins/thirdparty
#chown www-data:www-data plugin_highcharts.js

1 2	#cd /var/www/html/freeboard/plugins/thirdparty #chown www-data:www-data plugin_highcharts.js

Edit again the file /var/www/html/freeboard/index.html and add the plugin as done above

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>freeboard</title>
        <meta name="mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-capable" content="yes" />
    <meta name="apple-mobile-web-app-status-bar-style" content="black" />
    <meta name="viewport" content = "width = device-width, initial-scale = 1, user-scalable = no" />
    <link href="css/freeboard.min.css" rel="stylesheet" />
    <script src="js/freeboard.thirdparty.min.js"></script>
    <script type="text/javascript">
        head.js("js/freeboard_plugins.min.js",
                "plugins/thirdparty/plugin_highcharts.js",
                "plugins/mqtt/paho.mqtt.plugin.js",
                // *** Load more plugins here ***
                function(){

<!DOCTYPE html>

<html>

<head>

<title>freeboard</title>

head.js("js/freeboard_plugins.min.js",

"plugins/thirdparty/plugin_highcharts.js",

"plugins/mqtt/paho.mqtt.plugin.js",

// *** Load more plugins here ***

function(){

Access now the Freeboard dashboard and add the links to the temperature and humidity topics, the gauges and timeseries mesauring the values in real time and in a specific range of time . Here are some settings:

Datasource

Gauge

Timeseries

Chrome/Chromium browser allows to save the settings in a json file. This settings can be loaded locally or loaded from the web server, saving for example the dashboard.json file in /var/www/html/freeboard, with the url

http://beaglebone.local/freeboard/index.html?load=dashboard.json

1	http://beaglebone.local/freeboard/index.html?load=dashboard.json

The image shows the Freeboad interface with various widgets showing the status and timeseries of the ESP8266 relay and sensors

In these series of articles we configured the envinronment to access the Beaglebone using the beaglebone.local/beaglebone alias

Debian sd card setup for Beaglebone Black

but you can use anyway the Beaglebone IP tho access the services provided by the board.

In the next article we’ll treat the Mqtt Android client

Mqtt with Beaglebone and ESP8266 – Android Client

Configuration, Software

MQTT with BeagleBone and ESP8266 – WebServer and MQTT WebSocket

2017-04-08 admin

After the MQTT server and ESP8266 nodes configurations

MQTT with BeagleBone and ESP8266 – Mosquitto installation on Beaglebone

MQTT with BeagleBone and ESP8266-MQTT ESP8266

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with temperature sensor

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with Relay

we analize now the webserver configuration on BeagleBone and the Websocket configuration for the broker MQTT mosquitto always on Beaglebone.

First step is to access on the Beaglebone in ssh and disable the following services

$sudo systemctl stop cloud9.service 
$sudo systemctl stop cloud9.socket 
$sudo systemctl disable cloud9.service
$sudo systemctl disable cloud9.socket
$sudo systemctl stop bonescript-autorun.service
$sudo systemctl stop bonescript.service
$sudo systemctl stop bonescript.socket
$sudo systemctl disable bonescript-autorun.service
$sudo systemctl disable bonescript.service
$sudo systemctl disable bonescript.socket
$sudo systemctl daemon-reload

$sudo systemctl stop cloud9.service

$sudo systemctl stop cloud9.socket

$sudo systemctl disable cloud9.service

$sudo systemctl disable cloud9.socket

$sudo systemctl stop bonescript-autorun.service

$sudo systemctl stop bonescript.service

$sudo systemctl stop bonescript.socket

$sudo systemctl disable bonescript-autorun.service

$sudo systemctl disable bonescript.service

$sudo systemctl disable bonescript.socket

$sudo systemctl daemon-reload

Go into the folder /etc/apache2/sites-enabled and modfy 000-default.conf changing the webserver port from 8080 to 80

<VirtualHost *:80>

1	<VirtualHost *:80>

In /etc/apache2/port.conf modify the listening port from 8080 to 80

# If you just change the port or add more ports here, you will likely also
# have to change the VirtualHost statement in
# /etc/apache2/sites-enabled/000-default.conf

Listen 80

# If you just change the port or add more ports here, you will likely also

# have to change the VirtualHost statement in

# /etc/apache2/sites-enabled/000-default.conf

Listen 80

Restart the Http server

sudo systemctl restart apache2

1	sudo systemctl restart apache2

Go into folder /etc/mosquitto/conf.d and create a new file websockets.conf with the following contents inside

listener 1883
protocol mqtt

listener 9001
protocol websockets

listener 1883

protocol mqtt

listener 9001

protocol websockets

Save the file and restart Mosquitto

sudo systemctl restart mosquitto

1	sudo systemctl restart mosquitto

Disable the IPV6 protocol on Beaglebone as described at the following link

Disable IPV6 in Debian

In the file /etc/sysctl.conf add

net.ipv6.conf.all.disable_ipv6 = 1
net.ipv6.conf.default.disable_ipv6 = 1
net.ipv6.conf.lo.disable_ipv6 = 1
net.ipv6.conf.eth0.disable_ipv6 = 1

net.ipv6.conf.all.disable_ipv6 = 1

net.ipv6.conf.default.disable_ipv6 = 1

net.ipv6.conf.lo.disable_ipv6 = 1

net.ipv6.conf.eth0.disable_ipv6 = 1

Restart the Beaglebone.

We proceed at this point to install on the http server a MQTT Websocket client and the Freeboard dashboard.

As for the MQTT Websocket client hive-MQTT we download the code from github

Hive mqtt

Log in as root in ssh on Beaglebone and go into /var/www/html folder; clone the Mqtt client into mqtt-web folder and change the owner of this folder

#cd /var/www/html/
#git clone https://github.com/hivemq/hivemq-mqtt-web-client.git mqtt-web
#chown www-data:www-data -R mqtt-web

#cd /var/www/html/

#git clone https://github.com/hivemq/hivemq-mqtt-web-client.git mqtt-web

#chown www-data:www-data -R mqtt-web

With a web browser navigate on our Http server to the mqtt-web link obtaining the Mqtt Web client; we can now set the parameters for the connection to the Mosquitto Mqtt Broker

Populating the values for the subscription and publishing topics we can access to the messages of the topics and the ability to perform a command to the publishing topic

In the next article we’ll install the Freeboad dashboard on the Beaglebone

Mqtt with Beaglebone and ESP8266 – Freeboard

Development, Hardware, Software

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with Relay

2017-04-01 admin

After the article about the connection with the temperature and humidity sensor

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with temperature sensor

in this article we set the esp8266 to run a relay. Here is how we connect the relay to the ESP module

In this example too we will consider the option of putting the nodemcu in sleep. To have the node back form the sleep the system has to reboot and it is necessary to connect the PIN D0 (GPIO16) to RST PIN as specified in the nodemcu documentation

Nodemcu sleep

Let us take a look at the lua code; It consists of init.lua and relay.lua files.

We analyze now the main points of each file

init.lua

-- init.lua
SSID="SSID" -- SSID 
PASSWORD="password" -- SSID password
TIMEOUT=10000   -- timeout to check the network status
EXSENSOR1="relay.lua"   -- module to run
MQTTSERVER="mqttaddress"   -- mqtt broker address
MQTTPORT="1883" -- mqtt broker port
MQTTQOS="0" -- qos used

-- Set the netowrk parameters and get ip address
wifi.setmode(wifi.STATION)
wifi.sta.config(SSID, PASSWORD)
wifi.sta.getip()


-- Check the network status after the TIMEOUT interval
tmr.alarm(0, TIMEOUT,tmr.ALARM_SINGLE, function()
    status=wifi.sta.status()
   -- if esp8266 got the ip
   if (status == wifi.STA_GOTIP ) then

        dofile(EXSENSOR1)
        
    
    else
        -- Without up restart the node
        print("Error acquiring ip address=",status)
        node.restart()
    end


end

)

-- init.lua

SSID="SSID" -- SSID

PASSWORD="password" -- SSID password

TIMEOUT=10000 -- timeout to check the network status

EXSENSOR1="relay.lua" -- module to run

MQTTSERVER="mqttaddress" -- mqtt broker address

MQTTPORT="1883" -- mqtt broker port

MQTTQOS="0" -- qos used

-- Set the netowrk parameters and get ip address

wifi.setmode(wifi.STATION)

wifi.sta.config(SSID, PASSWORD)

wifi.sta.getip()

-- Check the network status after the TIMEOUT interval

tmr.alarm(0, TIMEOUT,tmr.ALARM_SINGLE, function()

status=wifi.sta.status()

-- if esp8266 got the ip

if (status == wifi.STA_GOTIP ) then

dofile(EXSENSOR1)

else

-- Without up restart the node

print("Error acquiring ip address=",status)

node.restart()

end

)

In the file we set the the parameters to access the wifi network, the address and port of the MQTT broker and the file to be run on the ESP after wifi connection to the access point is estabilished. If the ESP doesn’t acquire the network address the system is restarted.

relay.lua

-- relay.lua
CNAME="relay1" -- Client name 
AMBIENT="home"  -- Ambient name 
STOPIC     = AMBIENT.."/"..CNAME.."/status"  -- Status topic
CTOPIC     = AMBIENT.."/"..CNAME.."/command" --Command topic   
MTOPIC     = AMBIENT.."/"..CNAME.."/monitor" --Monitor topic


sleep_in_seconds= nil --Sleep in seconds


TUPDATE = 20 -- Time interval for update monitor in seconds
RPIN        =1 -- Relay Pin
TGEN = 5 -- Time interval in seconds usend in various trm
gpio.mode(RPIN,gpio.OUTPUT) -- Set Relay pin mode
gpio.write(RPIN,gpio.LOW) -- Default output is OFF





-- Define Client Name and connection parameters
mqt = mqtt.Client(CNAME, 60, "", "", 1) 

-- Subscribe to the topics and send status to the status topic
mqt:on("connect", function() 
    mqt:subscribe(STOPIC, MQTTQOS)
    mqt:subscribe(CTOPIC, MQTTQOS)
    mqt:subscribe(MTOPIC, MQTTQOS)
    send_status("Relay ready again")
end )

-- Callback when mqtt is offline
mqt:on("offline", function() print("mqtt offline");  end)

--Callback to manage messages 
mqt:on("message", function(client, topic, data) 
    manage_message(client, topic, data) 
end)

-- Function to filter the messages
function manage_message(client, topic, data) 
    -- If CTOPIC: command topic
    if topic == CTOPIC then

        -- If the command is Restart
        if data == "Restart" then
            send_status("Restarting")
            send_mstatus("Restarting")
            tmr.alarm(2, TGEN*1000, tmr.ALARM_SINGLE, node.restart)
        -- If the command is null    
        elseif data == nil then
            send_status("Command not valid")
        -- Command to turn on the Relay    
        elseif data == "ON" then
            relay_on()
        -- Command to turn off the Relay    
        elseif data == "OFF" then
            relay_off()  
        -- Command to check the state of the Relay    
        elseif data == "Status" then
            relay_status()         
            
        else
            -- Check the Sleep command
            i=string.len(data)
            dato=string.sub(data,1,5)

            if dato == "Sleep" then
                ndato=string.sub(data,6)
                TSLEEP=tonumber(ndato)
                if TSLEEP ~= nil then

                    if TSLEEP >= 1 then
 
                        -- Sets the interval in seconds to sleep
                        sleep_in_seconds=TSLEEP*60
                        esp_sleep()
                    else
                        -- Send an error in Sleep command
                        send_status("Sleep command error")
                    
                    end
                else
                    -- Send an error in Sleep command 
                    send_status("Sleep command error")
                end

            else
                -- Command not managed           
                send_status("Command not valid")      

            end
            
        end
        
    end
end

-- Function to turn on the relay
function relay_on()
    
    gpio.write(RPIN,gpio.HIGH)
    send_status("Relay ON")
end

-- Function to turn off the relay
function relay_off()
    
    gpio.write(RPIN,gpio.LOW)
    send_status("Relay OFF")
end

-- Function to check if the the relay is on or off
function relay_status()
    
    risultato=gpio.read(RPIN)

    if(risultato==1) then
        send_status("Relay ON")
    elseif(risultato==0) then
        send_status("Relay OFF")
    end
end


-- Function to send messages to to STOPIC: status topic
function send_status(message)
    mqt:publish(STOPIC, message, MQTTQOS, 0)
    
end

-- Fucntion to send messages to MTOPIC: monitor topic
function send_mstatus(message)
    mqt:publish(MTOPIC, message, MQTTQOS, 0)
    
end


-- Function that sleeps esp8266
function esp_sleep()
 
    send_status("Relay going to sleep now")
    send_mstatus("Relay going to sleep now")
    -- Delayd sleep to send the message above.
    tmr.alarm(3, TGEN*1000, tmr.ALARM_SINGLE, function() 
        node.dsleep(sleep_in_seconds*1000000) 
    end)
end


-- Connection to the mqtt server at the msttport
mqt:connect(MQTTSERVER, MQTTPORT, 0, 1)



-- Send periodically a message to the monitor topic
tmr.alarm(4, TUPDATE*1000, tmr.ALARM_AUTO, function() send_mstatus("Relay Ready") end)

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

-- relay.lua

CNAME="relay1" -- Client name

AMBIENT="home" -- Ambient name

STOPIC = AMBIENT.."/"..CNAME.."/status" -- Status topic

CTOPIC = AMBIENT.."/"..CNAME.."/command" --Command topic

MTOPIC = AMBIENT.."/"..CNAME.."/monitor" --Monitor topic

sleep_in_seconds= nil --Sleep in seconds

TUPDATE = 20 -- Time interval for update monitor in seconds

RPIN =1 -- Relay Pin

TGEN = 5 -- Time interval in seconds usend in various trm

gpio.mode(RPIN,gpio.OUTPUT) -- Set Relay pin mode

gpio.write(RPIN,gpio.LOW) -- Default output is OFF

-- Define Client Name and connection parameters

mqt = mqtt.Client(CNAME, 60, "", "", 1)

-- Subscribe to the topics and send status to the status topic

mqt:on("connect", function()

mqt:subscribe(STOPIC, MQTTQOS)

mqt:subscribe(CTOPIC, MQTTQOS)

mqt:subscribe(MTOPIC, MQTTQOS)

send_status("Relay ready again")

end )

-- Callback when mqtt is offline

mqt:on("offline", function() print("mqtt offline"); end)

--Callback to manage messages

mqt:on("message", function(client, topic, data)

manage_message(client, topic, data)

end)

-- Function to filter the messages

function manage_message(client, topic, data)

-- If CTOPIC: command topic

if topic == CTOPIC then

-- If the command is Restart

if data == "Restart" then

send_status("Restarting")

send_mstatus("Restarting")

tmr.alarm(2, TGEN*1000, tmr.ALARM_SINGLE, node.restart)

-- If the command is null

elseif data == nil then

send_status("Command not valid")

-- Command to turn on the Relay

elseif data == "ON" then

relay_on()

-- Command to turn off the Relay

elseif data == "OFF" then

relay_off()

-- Command to check the state of the Relay

elseif data == "Status" then

relay_status()

else

-- Check the Sleep command

i=string.len(data)

dato=string.sub(data,1,5)

if dato == "Sleep" then

ndato=string.sub(data,6)

TSLEEP=tonumber(ndato)

if TSLEEP ~= nil then

if TSLEEP >= 1 then

-- Sets the interval in seconds to sleep

sleep_in_seconds=TSLEEP*60

esp_sleep()

else

-- Send an error in Sleep command

send_status("Sleep command error")

end

else

-- Send an error in Sleep command

send_status("Sleep command error")

end

else

-- Command not managed

send_status("Command not valid")

end

-- Function to turn on the relay

function relay_on()

gpio.write(RPIN,gpio.HIGH)

send_status("Relay ON")

end

-- Function to turn off the relay

function relay_off()

gpio.write(RPIN,gpio.LOW)

send_status("Relay OFF")

end

-- Function to check if the the relay is on or off

function relay_status()

risultato=gpio.read(RPIN)

if(risultato==1) then

send_status("Relay ON")

elseif(risultato==0) then

send_status("Relay OFF")

end

-- Function to send messages to to STOPIC: status topic

function send_status(message)

mqt:publish(STOPIC, message, MQTTQOS, 0)

end

-- Fucntion to send messages to MTOPIC: monitor topic

function send_mstatus(message)

mqt:publish(MTOPIC, message, MQTTQOS, 0)

end

-- Function that sleeps esp8266

function esp_sleep()

send_status("Relay going to sleep now")

send_mstatus("Relay going to sleep now")

-- Delayd sleep to send the message above.

tmr.alarm(3, TGEN*1000, tmr.ALARM_SINGLE, function()

node.dsleep(sleep_in_seconds*1000000)

end)

end

-- Connection to the mqtt server at the msttport

mqt:connect(MQTTSERVER, MQTTPORT, 0, 1)

-- Send periodically a message to the monitor topic

tmr.alarm(4, TUPDATE*1000, tmr.ALARM_AUTO, function() send_mstatus("Relay Ready") end)

The relay.lua file manages the relay, the subscription on MQTT broker with submission of the data. Global parameters have been set to manage the topic, the waiting time in tmr.alarm. There are in particular the following topics

/home/relay1/status : Status topic. The status is sent at the start and at request from the command topic /home/relay1/command.
/home/relay1/monitor: Status of the esp sent periodically to this topic.
/home/relay1/command: Other clients can send commands to the esp:
- Restart: Restarts the esp.
- Sleep n: Put to sleep for n seconds the esp.
- ON: Turn on the relay.
- OFF: Turn off the relay.
- Status: Request of tthe relay status (ON or OFF).

There are various service functions to manage all. The comments in the code describe each feature.

In the next article we will set up the webserver on Beaglebone and the websocket configuration for Mosquitto always on the Beaglebone

MQTT with BeagleBone and ESP8266 – WebServer and MQTT WebSocket

Development, Hardware, Software

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with temperature sensor

2017-03-23 admin

After loading the firmware into the device esp8266

MQTT with BeagleBone and ESP8266-MQTT ESP8266

we now connect this module with a DHT11 temperature and humidity sensor. Here is how we connect the sensor to the ESP module

In this example we will consider the option of putting the nodemcu in sleep. To have the node back form the sleep the system has to reboot and it is necessary to connect the PIN D0 (GPIO16) to RST PIN as specified in the nodemcu documentation

Nodemcu sleep

Let us take a look at the lua code; It consists of init.lua and tempumid.lua files.

We analyze now the main points of each file

init.lua

-- init.lua
SSID="SSDNAME" -- SSID 
PASSWORD="passwordssid" -- SSID password
TIMEOUT=10000    -- timeout to check the network status
EXSENSOR1="tempumid.lua"    -- module to run
MQTTSERVER="mqttbrokeraddress"   -- mqtt broker address
MQTTPORT="1883"  -- mqtt borker port
MQTTQOS="0" -- qos used

-- Set the netowrk parameters and get ip address
wifi.setmode(wifi.STATION)
wifi.sta.config(SSID, PASSWORD)
wifi.sta.getip()

-- Check the network status after the TIMEOUT interval
tmr.alarm(0, TIMEOUT,tmr.ALARM_SINGLE, function()
    status=wifi.sta.status()
    
    -- if esp8266 got the ip
   if (status == wifi.STA_GOTIP ) then

       dofile(EXSENSOR1)
        
    
    else
        -- Without ip restart the node
        print("Error acquiring ip address=",status)
        node.restart()
    end


end

-- init.lua

SSID="SSDNAME" -- SSID

PASSWORD="passwordssid" -- SSID password

TIMEOUT=10000 -- timeout to check the network status

EXSENSOR1="tempumid.lua" -- module to run

MQTTSERVER="mqttbrokeraddress" -- mqtt broker address

MQTTPORT="1883" -- mqtt borker port

MQTTQOS="0" -- qos used

-- Set the netowrk parameters and get ip address

wifi.setmode(wifi.STATION)

wifi.sta.config(SSID, PASSWORD)

wifi.sta.getip()

-- Check the network status after the TIMEOUT interval

tmr.alarm(0, TIMEOUT,tmr.ALARM_SINGLE, function()

status=wifi.sta.status()

-- if esp8266 got the ip

if (status == wifi.STA_GOTIP ) then

dofile(EXSENSOR1)

else

-- Without ip restart the node

print("Error acquiring ip address=",status)

node.restart()

end

In the file we set the the parameters to access the wifi network, the address and port of the MQTT broker and the file to be run on the ESP after wifi connection to the access point is estabilished. If the ESP does’t acquire the netowrk address the system is restarted.

tempumid.lua

-- tempumid.lua
CNAME="room1" -- Client name 
AMBIENT="home"  -- Ambient name
TTOPIC     = AMBIENT.."/"..CNAME.."/temperature"  -- Temperature topic
HTOPIC     = AMBIENT.."/"..CNAME.."/humidity"  -- Humidity topic 
STOPIC     = AMBIENT.."/"..CNAME.."/status"  -- Status topic
CTOPIC     = AMBIENT.."/"..CNAME.."/command" --Command topic   
MTOPIC     = AMBIENT.."/"..CNAME.."/monitor" --Monitor topic


sleep_in_seconds= nil --Sleep in seconds


TUPDATE = 15 -- Time interval for update monitor in seconds
TUPTEMP = 10 -- Time interval for update temperature and humidity values
SPIN         = 4  -- Sensor pin
TGEN = 5 -- Time interval in seconds usend in various trm


-- Define Client Name and connection parameters
mqt = mqtt.Client(CNAME, 60, "", "", 1) 

-- Subscribe to the topics and send status to the status topic
mqt:on("connect", function() 
    mqt:subscribe(STOPIC, MQTTQOS)
    mqt:subscribe(CTOPIC, MQTTQOS)
    mqt:subscribe(MTOPIC, MQTTQOS)
    mqt:subscribe(TTOPIC, MQTTQOS)
    mqt:subscribe(HTOPIC, MQTTQOS)
    send_status("Sensor ready again")
end )

-- Callback when mqtt is offline
mqt:on("offline", function() print("mqtt offline");  end)

--Callback to manage messages 
mqt:on("message", function(client, topic, data) 
    manage_message(client, topic, data) 
end)


-- Function to filter the messages
function manage_message(client, topic, data) 
    -- If CTOPIC: command topic
    if topic == CTOPIC then
        --print("Command")
        -- If the command is Restart
        if data == "Restart" then
            send_status("Restarting")
            send_mstatus("Restarting")
            tmr.alarm(2, TGEN*1000, tmr.ALARM_SINGLE, node.restart)
            --print("restart")
        -- If the command is null    
        elseif data == nil then
           -- print("Command not valid")
            send_status("Command not valid")
        
        
        else
            -- Check the Sleep command           
            i=string.len(data)
            dato=string.sub(data,1,5)
          
            if dato == "Sleep" then
                ndato=string.sub(data,6)
                TSLEEP=tonumber(ndato)
                if TSLEEP ~= nil then
                    if TSLEEP >= 1 then
                        -- Sets the interval in seconds to sleep
                        sleep_in_seconds=TSLEEP*60
                        esp_sleep()
                    else
                        -- Send an error in Sleep command
                        send_status("Sleep command error")
                    
                    end
                else
                    -- Send an error in Sleep command 
                    send_status("Sleep command error")
                end

            else
                -- Command not managed           
                send_status("Command not valid")      

            end
            
        end
        
    end
end

-- Function to send messages to STOPIC: status topic
function send_status(message)
    mqt:publish(STOPIC, message, MQTTQOS, 0)
    
end

-- Fucntion to send messages to MTOPIC: monitor topic
function send_mstatus(message)
    mqt:publish(MTOPIC, message, MQTTQOS, 0)
    
end

-- Function to display temp and hum
function display_temphum(temp,humi)
    print("Temperature=%d, Humidity=%d",temp,humi)
end

 
-- Function to read and publish temperature and humidity
function read_temp_hum(client)
    status, temp, humi, temp_dec, humi_dec = dht.read(SPIN)
    if status == dht.OK then
    
        mqt:publish(TTOPIC, temp,MQTTQOS, 0)
        mqt:publish(HTOPIC, humi, MQTTQOS, 0)
        
       -- display_temphum(temp,humi)
       
    elseif status == dht.ERROR_CHECKSUM then
        print( "DHT Checksum error." )
    elseif status == dht.ERROR_TIMEOUT then
        print( "DHT timed out." )
    end
end


-- Function that sleeps esp8266
function esp_sleep()
 
    send_status("Sensor going to sleep now")
    send_mstatus("Sensor going to sleep now")
    -- Delayd sleep to send the message above.
    tmr.alarm(3, TGEN*1000, tmr.ALARM_SINGLE, function() 
        node.dsleep(sleep_in_seconds*1000000) 
    end)
end

-- Connection to the mqtt server at the mqttport
mqt:connect(MQTTSERVER, MQTTPORT, 0, 1)

--Sends periodically the temperature and humidity to the topics
tmr.alarm(1, TUPTEMP*1000, tmr.ALARM_AUTO, function() read_temp_hum(mqt) end)

-- Sends periodically a message to the monitor topic
tmr.alarm(4, TUPDATE*1000, tmr.ALARM_AUTO, function() send_mstatus("Sensor Ready") end)

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

-- tempumid.lua

CNAME="room1" -- Client name

AMBIENT="home" -- Ambient name

TTOPIC = AMBIENT.."/"..CNAME.."/temperature" -- Temperature topic

HTOPIC = AMBIENT.."/"..CNAME.."/humidity" -- Humidity topic

STOPIC = AMBIENT.."/"..CNAME.."/status" -- Status topic

CTOPIC = AMBIENT.."/"..CNAME.."/command" --Command topic

MTOPIC = AMBIENT.."/"..CNAME.."/monitor" --Monitor topic

sleep_in_seconds= nil --Sleep in seconds

TUPDATE = 15 -- Time interval for update monitor in seconds

TUPTEMP = 10 -- Time interval for update temperature and humidity values

SPIN = 4 -- Sensor pin

TGEN = 5 -- Time interval in seconds usend in various trm

-- Define Client Name and connection parameters

mqt = mqtt.Client(CNAME, 60, "", "", 1)

-- Subscribe to the topics and send status to the status topic

mqt:on("connect", function()

mqt:subscribe(STOPIC, MQTTQOS)

mqt:subscribe(CTOPIC, MQTTQOS)

mqt:subscribe(MTOPIC, MQTTQOS)

mqt:subscribe(TTOPIC, MQTTQOS)

mqt:subscribe(HTOPIC, MQTTQOS)

send_status("Sensor ready again")

end )

-- Callback when mqtt is offline

mqt:on("offline", function() print("mqtt offline"); end)

--Callback to manage messages

mqt:on("message", function(client, topic, data)

manage_message(client, topic, data)

end)

-- Function to filter the messages

function manage_message(client, topic, data)

-- If CTOPIC: command topic

if topic == CTOPIC then

--print("Command")

-- If the command is Restart

if data == "Restart" then

send_status("Restarting")

send_mstatus("Restarting")

tmr.alarm(2, TGEN*1000, tmr.ALARM_SINGLE, node.restart)

--print("restart")

-- If the command is null

elseif data == nil then

-- print("Command not valid")

send_status("Command not valid")

else

-- Check the Sleep command

i=string.len(data)

dato=string.sub(data,1,5)

if dato == "Sleep" then

ndato=string.sub(data,6)

TSLEEP=tonumber(ndato)

if TSLEEP ~= nil then

if TSLEEP >= 1 then

-- Sets the interval in seconds to sleep

sleep_in_seconds=TSLEEP*60

esp_sleep()

else

-- Send an error in Sleep command

send_status("Sleep command error")

end

else

-- Send an error in Sleep command

send_status("Sleep command error")

end

else

-- Command not managed

send_status("Command not valid")

end

-- Function to send messages to STOPIC: status topic

function send_status(message)

mqt:publish(STOPIC, message, MQTTQOS, 0)

end

-- Fucntion to send messages to MTOPIC: monitor topic

function send_mstatus(message)

mqt:publish(MTOPIC, message, MQTTQOS, 0)

end

-- Function to display temp and hum

function display_temphum(temp,humi)

print("Temperature=%d, Humidity=%d",temp,humi)

end

-- Function to read and publish temperature and humidity

function read_temp_hum(client)

status, temp, humi, temp_dec, humi_dec = dht.read(SPIN)

if status == dht.OK then

mqt:publish(TTOPIC, temp,MQTTQOS, 0)

mqt:publish(HTOPIC, humi, MQTTQOS, 0)

-- display_temphum(temp,humi)

elseif status == dht.ERROR_CHECKSUM then

print( "DHT Checksum error." )

elseif status == dht.ERROR_TIMEOUT then

print( "DHT timed out." )

end

-- Function that sleeps esp8266

function esp_sleep()

send_status("Sensor going to sleep now")

send_mstatus("Sensor going to sleep now")

-- Delayd sleep to send the message above.

tmr.alarm(3, TGEN*1000, tmr.ALARM_SINGLE, function()

node.dsleep(sleep_in_seconds*1000000)

end)

end

-- Connection to the mqtt server at the mqttport

mqt:connect(MQTTSERVER, MQTTPORT, 0, 1)

--Sends periodically the temperature and humidity to the topics

tmr.alarm(1, TUPTEMP*1000, tmr.ALARM_AUTO, function() read_temp_hum(mqt) end)

-- Sends periodically a message to the monitor topic

tmr.alarm(4, TUPDATE*1000, tmr.ALARM_AUTO, function() send_mstatus("Sensor Ready") end)

The temumid.lua file manages the measurement of temperature and humidity, the subscription on MQTT broker with submission of the data. Global parameters have been set to manage the topic, the waiting time in tmr.alarm. There are in particular the following topics

/home/room1/temperature: measured temperature topic.
/home/room1/humidity: measured humidity topic.
/home/room1/status : Status topic. The status is sent at the start and at request from the command topic /home/room1/command.
/home/room1/monitor: Status of the esp sent periodically to this topic.
/home/room1/command: Other clients can send commands to the esp:
- Restart: Restarts the esp.
- Sleep n: Put to sleep for n seconds the esp.

There are various service functions to manage all. The comments in the code describe each feature.

In the next article we will set up the esp with the relay

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with Relay

Configuration, Software

Mqtt with Beaglebone and ESP8266-MQTT ESP8266

2017-03-19 admin

After installing the MQTT server on BeagleBone

Mqtt with Beaglebone and ESP8266-Mosquitto installation on Beaglebone

let us set the MQTT nodes on ESP8266.

As first operation we must generate the nodemcu firmware, as described in the previous article

Nodemcu compilation on Linux

with at least the following parameters activated in user_module.h file

DHT
file
GPIO
MQTT
net
node
timer
UART
WiFi

These settings are the default in the user_module.h file.

At present the latest version 2.0 of nomemcu firmware was released. Here are the compiled files for this version of the firmware

Nodemcu2.0.0 firmware

As already described in previous articles and from the nodecmu link on flashing

Flashing the firmware

we have to set the correct parameters for the esp8266 model.

In our case, with 4MB flash, we used the parameters shown in the image to load the firmware on the device with nodemcu-flasher tool. You can also use other tools for loading the firmware. In our case, the settings used are as follows

In the next article we’ll treat the ESP8266 node that detects temperature and humidity

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with temperature sensor

Micro Devices

Tag Archives: esp8266

Micropython – Development tools Ampy – Eric

Micropython – MicroPython IDE uPyCraft

MicroPython – Python on embedded devices

Mqtt with Beaglebone and ESP8266 – Articles List

Mqtt with Beaglebone and ESP8266 – Android Client

Mqtt with Beaglebone and ESP8266 – Freeboard

MQTT with BeagleBone and ESP8266 – WebServer and MQTT WebSocket

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with Relay

MQTT with BeagleBone and ESP8266 – MQTT on ESP8266 with temperature sensor

Mqtt with Beaglebone and ESP8266-MQTT ESP8266

Blog about embedded devices