Editing Tutorial Network

= Write and Read Network Variables =
In this part of the tutorial, we explain how to write variables to the server and how to read them again.
This is a very simple module/library with very basic functionality to connect objects by using shared variables in the network

== Success criteria ==
* you can write a variable to the network
* you can read a variable from the network
* you understand how the network variables work 
* you understand the limitations of the module (only strings, everyone can read and write all variables, naming conditions)

== Required Module and Files ==
* We use '''[https://www.sketching-with-hardware.org/files/netvars.py netvars.py]'''
* OPTIONAL: you can download the files to set up your own server. This is in php and requires mySQL. https://www.sketching-with-hardware.org/files/netvarsServer.zip (see readme for details)

== Related Components ==

The components are related to the [[LMUBox]]. For more components, see the [[Hardware List]]. Many of the pages on actuators and sensor include additional examples.

=== Microcontroller ===
* [[ESP32 Web Kit]] with integrated OLED Display from Heltec

= Instructional Videos =

== Connecting to WiFI and using Network Variables  ==
In this video on youtube (8:52) we show how to Connect the ESP32/ESP8266 to the Internet and how to use the netvars.py module to use variables stored on the server. 

<youtube>PJ3nQo_Hw3I</youtube>

== Using the uPyCraft IDE to upload files ==
In this video on youtube (6:48), we show how to upload an run python files with the [[uPyCraft]] IDE: https://youtu.be/MXfj_gWf0z4 

<youtube>MXfj_gWf0z4</youtube>

= Code Examples = 

== Code Example: using netvars.py == 
Variable names can only be strings of letters and numbers without space
Variable values can only be strings of letters and numbers without space (numbers will be converted to strings), spaces will give an error
You are welcome to improve the module!

<syntaxhighlight lang="python" line='line'>
#Example usage

#import module
from netvars import setNetVar, getNetVar, initNet

# # assuming there is a network with ssid hotspot1 and password 123456789
# connect to wifi
initNet("hotspot1", "123456789")

# set the variale with the name test222 to the value valTest222
setNetVar("test222", "valTest222")

# read the variable test222 from the server and print it
a=getNetVar("test222")
print(a) # will print valTest222
</syntaxhighlight>

== Code Example for use in Jupyter Notebook: updated netvars.py == 
This has our server address hard coded - if you run it on your server you have to adapt the URLs.

<syntaxhighlight lang="python" line='line'>
import network, socket

def initNet(ssid, passwd):
    wlan = network.WLAN(network.STA_IF)
    wlan.active(True)
    if not wlan.isconnected():
        print('connecting to network...')
        wlan.connect(ssid, passwd)
        while not wlan.isconnected():

            pass
    print('network config:', wlan.ifconfig())

def http_get(url):
    #print(url)
    #print("............")
    _, _, host, path = url.split('/', 3)
    addr = socket.getaddrinfo(host, 80)[0][-1]
    print ("fetch from: ", addr)
    s = socket.socket()
    s.connect(addr)
    s.send(bytes('GET /%s HTTP/1.1\r\nHost: %s\r\n\r\n' % (path, host), 'utf8'))
    #print(s)
    retStr =""
    while True:
        data = s.recv(1024)
        #print(data)
        
        if data:
            # this would be all
            #retStr = retStr +str(data, 'utf8') 
            # Only the last line
            retStr = str(data, 'utf8') 
            #print(str(data, 'utf8'), end='')
            #print(retStr)
            break
        else:
            print("---data")
            #print(retStr)
            break
    s.close()
    return retStr


def setNetVar(varName, varVal):
    urlStr = "https://ubicomp.net/sw/db1/var2db.php?varName=" + str(varName) + "&varValue=" + str(varVal)
    #print(urlStr)
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test3&varValue=14")
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test222&varValue=valTest222")
    http_get(urlStr)


def getNetVar(varName):
    urlStr = "https://ubicomp.net/sw/db1/var2db.php?varName=" + str(varName) 
    #print(urlStr)
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test3&varValue=14")
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test222&varValue=valTest222")
    resStr = http_get(urlStr)
    # import re # standrad python
    import ure
    #_, retVar0 = ure.split('\r\n\r\n|\n\n',resStr)
    # retVar = ure.split(' |\n|\r',retVar0)
    reg1 = ure.compile('\r\n\r\n|\n\n')
    reg2 = ure.compile(' |\n|\r')
    #print(reg1)
    #print(reg1.split(resStr))
    _, retVar0, _ = reg1.split(resStr)
    #print(retVar0)
    retVar = reg2.split(retVar0)
    #print(retVar)
    return retVar[2]

#Example usage
# from netvars import setNetVar, getNetVar, http_get, initNet
# # assuming there is a network with ssid hotspot1 and password 123456789
# initNet("hotspot1", "123456789")
# setNetVar("test222", "valTest222")
# a=getNetVar("test222")
# print(a) # will print valTest222

# # assuming there is a network with ssid hotspot1 and password 123456789
# connect to wifi
initNet("as62", "VivienPetraAlbrecht")
# set the variale with the name test222 to the value valTest222
setNetVar("1000_albrecht_test222", "XXXalbrecht_valTest222")
# read the variable test222 from the server and print it
a=getNetVar("1000_albrecht_test222")
print(a) # will print valTest222
</syntaxhighlight>


== Code Example: netvars.py == 
This has our server address hard coded - if you run it on your server you have to adapt the URLs.

<syntaxhighlight lang="python" line='line'>
import network

def initNet(ssid, passwd):
    wlan = network.WLAN(network.STA_IF)
    wlan.active(True)
    if not wlan.isconnected():
        print('connecting to network...')
        wlan.connect(ssid, passwd)
        while not wlan.isconnected():

            pass
    print('network config:', wlan.ifconfig())

def http_get(url):
    #print(url)
    #print("............")
    import socket
    _, _, host, path = url.split('/', 3)
    addr = socket.getaddrinfo(host, 80)[0][-1]
    s = socket.socket()
    s.connect(addr)
    s.send(bytes('GET /%s HTTP/1.0\r\nHost: %s\r\n\r\n' % (path, host), 'utf8'))
    retStr =""
    while True:
        data = s.recv(500)
        if data:
            # this would be all
            # retStr = retStr +str(data, 'utf8') 
            # Only the last line
            retStr = str(data, 'utf8') 
            #print(str(data, 'utf8'), end='')
        else:
            break
    s.close()
    return retStr


def setNetVar(varName, varVal):
    urlStr = "https://ubicomp.net/sw/db1/var2db.php?varName=" + str(varName) + "&varValue=" + str(varVal)
    # print(urlStr)
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test3&varValue=14")
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test222&varValue=valTest222")
    http_get(urlStr)


def getNetVar(varName):
    urlStr = "https://ubicomp.net/sw/db1/var2db.php?varName=" + str(varName) 
    # print(urlStr)
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test3&varValue=14")
    # http_get("https://ubicomp.net/sw/db1/var2db.php?varName=test222&varValue=valTest222")
    resStr = http_get(urlStr)
    # import re # standrad python
    import ure
    #_, retVar0 = ure.split('\r\n\r\n|\n\n',resStr)
    # retVar = ure.split(' |\n|\r',retVar0)
    reg1 = ure.compile('\r\n\r\n|\n\n')
    reg2 = ure.compile(' |\n|\r')
    _, retVar0 = reg1.split(resStr)
    retVar = reg2.split(retVar0)
    return retVar[0]

#Example usage
# from netvars import setNetVar, getNetVar, http_get, initNet
# # assuming there is a network with ssid hotspot1 and password 123456789
# initNet("hotspot1", "123456789")
# setNetVar("test222", "valTest222")
# a=getNetVar("test222")
# print(a) # will print valTest222
</syntaxhighlight>


== Debugging Network Variables ==
For debugging you can see all the variables in our test installation by accessing:
https://ubicomp.net/sw/db1/var2db.php

[[Category:Tutorials]]