Browse Source

some changes

added esp book and links
Federico Bonelli 2 years ago
parent
commit
54a4dad8aa
3 changed files with 296 additions and 1 deletions
  1. BIN
      docs/ESP8266_ESP32.pdf
  2. 150 0
      guide.md
  3. 146 1
      readme.md

BIN
docs/ESP8266_ESP32.pdf


+ 150 - 0
guide.md

@@ -0,0 +1,150 @@
1
+# Notes for Dowse workshops setup and materials
2
+
3
+
4
+# Dowse
5
+- Web site is www.dowse.eu
6
+- Dyne is spelled as here; our website is www.dyne.org
7
+- irc channel is irc.dyne.org #dowse, feel welcome also to join in via https://irc.dyne.org
8
+- fredd email is fredd@dyne.org
9
+- Mailing list is dowse@dyne.org
10
+
11
+
12
+# How to deploy Dowse on a Raspberry Pi
13
+- you need:
14
+- a Raspberry Pi (version 2 or 3)
15
+- a power supply with at least 2A power (the Raspberry Pi 3 needs 2.5A) and a Micro-USB connector
16
+- a MicroSD card with at least 4GB capacity, class 10
17
+- the Dowse image file from http://www.dowse.eu/ (until the new file is up you can take it from here. This is the image that Jaromil gave out at the workshop on September 27: https://www.khm.de/~sievers/devuan_dowse_raspi2.img )
18
+
19
+- use your computer to clone the image onto the SD card (https://duckduckgo.com/?q=clone+raspberry+sd+card)
20
+- put the SD card into your Raspberry Pi
21
+- connect it to your access point/router via an Ethernet cable
22
+- optional: you can connect a monitor via HDMI and keyboard and mouse, but you'll have to do it before powering it up. This might be useful at the beginning because you can log in to it right away, get its IP address and change settings, etc.
23
+- connect it to power to boot it up
24
+- Dowse should now be running!
25
+
26
+- Log in to your home router/access point
27
+- disable DHCP (also for IPv6 if that is on, as apparently Windows 10 uses IPv6 for DNS)
28
+
29
+
30
+- The router will give you the Dowse box's IP address. With the default SD card image Dowse takes its IP via DHCP
31
+- Use that to SSH into your Dowse box, i.e. with ssh root@192.168.0.1
32
+- set up a static IP address for your dowse box (edit /etc/network/interfaces). After all, you have disabled the router's DHCP, so if you ever reboot the Dowse box (your new DHCP server), it will want to know which IP it should have.
33
+
34
+There are two users set up, root and dowse. The default password for root is toor, for the user dowse it is dowse. Log in as dowse to go straight to the interactive Dowse console.
35
+
36
+## How to say Dowse is running:
37
+- find out its IP address. Your router might tell you if you log in to its web interface, or try an app like https://github.com/adafruit/Adafruit-Pi-Finder/releases/tag/3.0.0
38
+
39
+- Let's assume it's 10.0.1.10. Open a Terminal and type
40
+ping 10.0.1.10
41
+- or open http://dowse.it in your browser. You should see the captive portal. Enter yourself as the administrator.
42
+
43
+- another way to check that the captive portal works:
44
+dig 10.0.1.10 dowse.it
45
+
46
+## How to say dowse is running on WIN machines
47
+- Open the startmenu and type as a command to run 'cmd' - it will open a commandprompt
48
+- run 'ping dowse.it'
49
+- if it says 'xx bytes from dowse.it … time=xx ms' a few times, it works!
50
+- Open 'dowse.it' in your browser
51
+
52
+## Troubleshooting
53
+- Dowse runs your DHCP. If it fails, try to disable the DHCP on your router
54
+- Check if there is a seperate DHCPv6 that might cause IPv6 resolving issues (Windows 10 uses IPv6 for DNS)
55
+
56
+
57
+# How to start OSC
58
+
59
+ssh into the dowse box (See 'Putty' further down if you are on Windows)
60
+
61
+then start:
62
+
63
+/usr/local/dowse/bin/dowse-to-osc osc.udp://ip-of-machine-to-send-to:port/path
64
+
65
+to make it start at every boot, put this line inside the file /etc/rc.local (edit as root)
66
+
67
+
68
+## Node Red
69
+A graphical editor to edit node patches/flows. Such flows allow reacting to input (like Dowse MQTT data). Not required to use Dowse. You can write your own programms or create gadgets that recieve MQTT or OSC data and do things with it.
70
+- http://nodered.org
71
+
72
+after installing node red you can follow a great tutorial :
73
+- http://noderedguide.com/node-red-lecture-2-building-your-first-flows-15/
74
+
75
+
76
+(It can also be installed on the dowse box, right? Following the instructions here, will report back if it works: https://learn.adafruit.com/raspberry-pi-hosting-node-red/setting-up-node-dot-js
77
+
78
+
79
+### Node.js
80
+- https://nodejs.org/en/download/
81
+
82
+### Installation Linux
83
+- install node.js
84
+- in terminal
85
+sudo npm install -g --unsafe-perm node-red
86
+
87
+### Installation Mac
88
+- install via homebrew https://brew.sh/
89
+First install brew if it isn't already, then follow instructions here: http://flnkr.com/2016/03/node-red-install-on-mac-os-x/
90
+
91
+- once installed run: /usr/local/bin/node-red -v
92
+- then open http://127.0.0.1:1880 in your browser
93
+follow instructions on node-red documentation
94
+
95
+### Installation Win
96
+go to node.js website and install node.js
97
+https://nodejs.org/en/
98
+
99
+open node terminal
100
+type: sudo npm install -g --unsafe-perm node-red
101
+
102
+
103
+## Gource
104
+Gource allows to visualize the data using a colorful, dynamic and animated graph. It's processor-intensive so it should be run on a client machine.
105
+- http://gource.io/
106
+
107
+### How to use Gource on a windows machine
108
+- Windows does not come with SSH. It is possible to use an alternative SSH-client called 'Putty' (Download URL: https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)
109
+- After installing, there is a ssh console client called plink.exe. It might not be in your 'PATH'. To run it from windows commandline, you need to specify the whole path. E.g. "c:\Program Files\Putty\plink.exe …"
110
+- When piping the output to gource, Windows does not show the interactive prompot for the password. But you can specify the password via the commandline switch -pw
111
+
112
+<full_path_to_putty>\plink.exe -pw dowse -l dowse dowse.it /usr/local/dowse/bin/dowse-to-gource | <full_path_to_gource>\gource.exe --log-format custom -
113
+
114
+Alternative:
115
+- Instead of cmd/powershell, use a shell that knows SSH and such tools like 'https://babun.github.io/'
116
+- Untested, please document :-)
117
+
118
+### On Mac:
119
+install via homebrew https://brew.sh/
120
+First install brew if it isn't already, then just do brew install gource
121
+Once installed, start gource on your own laptop with
122
+ssh -l dowse 10.0.1.10 /usr/local/dowse/bin/dowse-to-gource | gource --log-format custom - #password is dowse
123
+
124
+### general
125
+you can also get dns queries listed directly in your shell i.e. with
126
+ssh -l dowse 10.0.1.10 /usr/local/dowse/bin/dowse-to-gource
127
+
128
+
129
+
130
+## Notes about making the workshop better (feel free to add)
131
+- Remember that to Setup dowse for WS takes always a bit...
132
+- Start a local etterpad for the workshop to begin with
133
+- point to a page already populated with documentation,
134
+- instruct on how to change the documentation
135
+- Bring white board markers !
136
+- default dowse for WORKSHOPS is partymode (everyone gets online immediately)
137
+- explain rapidly how the lan works in regard to DNS queries
138
+
139
+
140
+## ESP
141
+- pointer page https://blog.falafel.com/esp8266-firmware/
142
+- ESP boards to Arduino IDE https://github.com/esp8266/arduino
143
+- http://esp8266.github.io/Arduino/versions/2.3.0/doc/installing.html
144
+- https://learn.adafruit.com/adafruit-feather-huzzah-esp8266/using-nodemcu-lua?view=all
145
+
146
+### Node MCU
147
+  - http://www.nodemcu.com/index_en.html
148
+
149
+### Node-red to Arduino
150
+- https://nodered.org/docs/hardware/arduino

+ 146 - 1
readme.md

@@ -1 +1,146 @@
1
-# Notes for Dowse workshops setup and materials
1
+# Notes for Dowse workshops setup and materials
2
+
3
+
4
+# Dowse
5
+- Web site is www.dowse.eu
6
+- Dyne is spelled as here; our website is www.dyne.org
7
+- irc channel is irc.dyne.org #dowse, feel welcome also to join in via https://irc.dyne.org
8
+- fredd email is fredd@dyne.org
9
+- Mailing list is dowse@dyne.org
10
+
11
+
12
+# How to deploy Dowse on a Raspberry Pi
13
+- you need:
14
+- a Raspberry Pi (version 2 or 3)
15
+- a power supply with at least 2A power (the Raspberry Pi 3 needs 2.5A) and a Micro-USB connector
16
+- a MicroSD card with at least 2GB capacity
17
+- the Dowse image file from http://www.dowse.eu/ (until the new file is up you can take it from here. This is the image that Jaromil gave out at the workshop on September 27: https://www.khm.de/~sievers/devuan_dowse_raspi2.img )
18
+
19
+- use your computer to clone the image onto the SD card (https://duckduckgo.com/?q=clone+raspberry+sd+card)
20
+- put the SD card into your Raspberry Pi
21
+- connect it to your access point/router via an Ethernet cable
22
+- optional: you can connect a monitor via HDMI and keyboard and mouse, but you'll have to do it before powering it up. This might be useful at the beginning because you can log in to it right away, get its IP address and change settings, etc.
23
+- connect it to power to boot it up
24
+- Dowse should now be running!
25
+
26
+- Log in to your home router/access point
27
+- disable DHCP (also for IPv6 if that is on, as apparently Windows 10 uses IPv6 for DNS)
28
+
29
+
30
+- The router will give you the Dowse box's IP address. With the default SD card image Dowse takes its IP via DHCP
31
+- Use that to SSH into your Dowse box, i.e. with ssh root@192.168.0.1
32
+- optional but probably a good idea: set up a static IP address for your dowse box (edit /etc/network/interfaces)
33
+
34
+There are two users set up, root and dowse. The default password for root is toor, for the user dowse it is dowse. Log in as dowse to go straight to the interactive Dowse console.
35
+
36
+## How to say Dowse is running:
37
+- find out its IP address. Your router might tell you if you log in to its web interface, or try an app like https://github.com/adafruit/Adafruit-Pi-Finder/releases/tag/3.0.0
38
+
39
+- Let's assume it's 10.0.1.10. Open a Terminal and type
40
+ping 10.0.1.10
41
+- or open http://dowse.it in your browser. You should see the captive portal. Enter yourself as the administrator.
42
+
43
+- another way to check that the captive portal works:
44
+dig 10.0.1.10 dowse.it
45
+
46
+## How to say dowse is running on WIN machines
47
+- Open the startmenu and type as a command to run 'cmd' - it will open a commandprompt
48
+- run 'ping dowse.it'
49
+- if it says 'xx bytes from dowse.it … time=xx ms' a few times, it works!
50
+- Open 'dowse.it' in your browser
51
+
52
+## Troubleshooting
53
+- Dowse runs your DHCP. If it fails, try to disable the DHCP on your router
54
+- Check if there is a seperate DHCPv6 that might cause IPv6 resolving issues (Windows 10 uses IPv6 for DNS)
55
+
56
+
57
+# How to start OSC
58
+
59
+ssh into the dowse box (See 'Putty' further down if you are on Windows)
60
+
61
+then start:
62
+
63
+/usr/local/dowse/bin/dowse-to-osc osc.udp://ip-of-machine-to-send-to:port/path
64
+
65
+to make it start at every boot, put this line inside the file /etc/rc.local (edit as root)
66
+
67
+
68
+## Node Red
69
+A graphical editor to edit node patches/flows. Such flows allow reacting to input (like Dowse MQTT data). Not required to use Dowse. You can write your own programms or create gadgets that recieve MQTT or OSC data and do things with it.
70
+- http://nodered.org
71
+
72
+after installing node red you can follow a great tutorial :
73
+- http://noderedguide.com/node-red-lecture-2-building-your-first-flows-15/
74
+
75
+
76
+(it's also already installed on the dowse box, right? How do I start it on there?)
77
+
78
+### Node.js
79
+- https://nodejs.org/en/download/
80
+
81
+### Installation Linux
82
+- install node.js
83
+- in terminal
84
+sudo npm install -g --unsafe-perm node-red
85
+
86
+### Installation Mac
87
+- install via homebrew https://brew.sh/
88
+First install brew if it isn't already, then follow instructions here: http://flnkr.com/2016/03/node-red-install-on-mac-os-x/
89
+
90
+- once installed run: /usr/local/bin/node-red -v
91
+- then open http://127.0.0.1:1880 in your browser
92
+follow instructions on node-red documentation
93
+
94
+### Installation Win
95
+go to node.js website and install node.js
96
+https://nodejs.org/en/
97
+
98
+open node terminal
99
+type: sudo npm install -g --unsafe-perm node-red
100
+
101
+
102
+## Gource
103
+Gource allows to visualize the data using a colorful, dynamic and animated graph. It's processor-intensive so it should be run on a client machine.
104
+- http://gource.io/
105
+
106
+### How to use Gource on a windows machine
107
+- Windows does not come with SSH. It is possible to use an alternative SSH-client called 'Putty' (Download URL: https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html)
108
+- After installing, there is a ssh console client called plink.exe. It might not be in your 'PATH'. To run it from windows commandline, you need to specify the whole path. E.g. "c:\Program Files\Putty\plink.exe …"
109
+- When piping the output to gource, Windows does not show the interactive prompot for the password. But you can specify the password via the commandline switch -pw
110
+
111
+<full_path_to_putty>\plink.exe -pw dowse -l dowse dowse.it /usr/local/dowse/bin/dowse-to-gource | <full_path_to_gource>\gource.exe --log-format custom -
112
+
113
+Alternative:
114
+- Instead of cmd/powershell, use a shell that knows SSH and such tools like 'https://babun.github.io/'
115
+- Untested, please document :-)
116
+
117
+### On Mac:
118
+install via homebrew https://brew.sh/
119
+First install brew if it isn't already, then just do brew install gource
120
+Once installed, start gource on your own laptop with
121
+ssh -l dowse 10.0.1.10 /usr/local/dowse/bin/dowse-to-gource | gource --log-format custom - #password is dowse
122
+
123
+### general
124
+you can also get dns queries listed directly in your shell i.e. with
125
+ssh -l dowse 10.0.1.10 /usr/local/dowse/bin/dowse-to-gource
126
+
127
+
128
+
129
+
130
+## Notes about making the workshop better (feel free to add)
131
+- Remember that to Setup dowse for WS takes always a bit
132
+- Start a etterpad for the workshop to begin with
133
+- point to a page already populated with documentation,
134
+- instruct on how to change the documentation
135
+- Bring white board markers !
136
+- default dowse is partymode (everyone gets online immediately)
137
+
138
+
139
+## ESP
140
+- pointer page https://blog.falafel.com/esp8266-firmware/
141
+- ESP boards to Arduino IDE https://github.com/esp8266/arduino
142
+- http://esp8266.github.io/Arduino/versions/2.3.0/doc/installing.html
143
+- https://learn.adafruit.com/adafruit-feather-huzzah-esp8266/using-nodemcu-lua?view=all
144
+
145
+### Node MCU
146
+  - http://www.nodemcu.com/index_en.html