Difference between revisions of "Spacestate sensors"

From Hackerspace ACKspace
Jump to: navigation, search
(added sonoff POW template)
(Added information about GPIO16 and SwitchMode 1 for Spacestate switch. Also listed references at the bottom.)
Line 6: Line 6:
 
|GitHub=SpaceAPI-sensors
 
|GitHub=SpaceAPI-sensors
 
}}
 
}}
−
 
+
This project ties strongly with the [[MQTT]] setup (to connect to the [[SpaceAPI]]) as it uses Tasmota<ref name="Tasmota">Tasmota homepage: https://tasmota.github.io/</ref> on [[ESP]] devices for feature bang and ease of use.
−
This project ties strongly with the [[MQTT]] setup (to connect to the [[SpaceAPI]]) as it uses [https://tasmota.github.io/ Tasmota] on [[ESP]] devices for feature bang and ease of use.
 
  
 
Note that you're more than welcome to add any sensor (or actuator) that you might see fit for our hackerspace. Think: 3D printer nozzle temperature or filament weight, outside radiation, air quality, motion sensing, window opener and the likes; this project is proof anyone that can handle a screwdriver and PC can do this.
 
Note that you're more than welcome to add any sensor (or actuator) that you might see fit for our hackerspace. Think: 3D printer nozzle temperature or filament weight, outside radiation, air quality, motion sensing, window opener and the likes; this project is proof anyone that can handle a screwdriver and PC can do this.
Line 15: Line 14:
  
 
=== intro ===
 
=== intro ===
−
After some iterations of the [[Space state]] switch and [[Mobile Spacestate Indicator|some versions]] of the [[Spacestate indicator]], some different types of temperature sensors, it was time to make it easy on ourselves: switch to [[MQTT]] and use [https://tasmota.github.io/ Tasmota].
+
After some iterations of the [[Space state]] switch and [[Mobile Spacestate Indicator|some versions]] of the [[Spacestate indicator]], some different types of temperature sensors, it was time to make it easy on ourselves: switch to [[MQTT]] and use Tasmota<ref name="Tasmota" />.
  
 
In most cases, an off-the-shelf ESP device will suffice, but since not all devices are not galvanically isolated from mains, it's more practical to use an ESP-12 PCB for things where contacts are bare (like the Space state switch).
 
In most cases, an off-the-shelf ESP device will suffice, but since not all devices are not galvanically isolated from mains, it's more practical to use an ESP-12 PCB for things where contacts are bare (like the Space state switch).
Line 29: Line 28:
 
* Click '''Configure Module'''
 
* Click '''Configure Module'''
 
* Make sure '''Module type''' is <code>ACKsensor (0)</code>
 
* Make sure '''Module type''' is <code>ACKsensor (0)</code>
−
* Set functions for '''GPIO17 (ADC)''', '''GPIO16''' (Typically <code>Switch 1</code> or <code>Button 1</code>) and '''GPIO12''' (<code>DS18x20</code> which is connected to 3.3v using ~4k7 pull up), see [https://tasmota.github.io/docs/GPIO-Conversion/ GPIO-Conversion] for details
+
* Set functions for '''GPIO17 (ADC)''', '''GPIO16''' (Typically <code>Switch 1</code> or <code>Button 1</code>) and '''GPIO12''' (<code>DS18x20</code> which is connected to 3.3v using ~4k7 pull up) <ref>GPIO-Conversion: https://tasmota.github.io/docs/GPIO-Conversion/</ref>
 
* Save (will reboot again)
 
* Save (will reboot again)
 
* Click '''Configure MQTT'''
 
* Click '''Configure MQTT'''
Line 36: Line 35:
  
 
=== notes and troubleshooting ===
 
=== notes and troubleshooting ===
 +
==== GPIO16 ====
 +
Note that this pin is special (it lives on a separate register internally, but more important, its internal pull resistor is to ground (pull-down) <ref>Github comment on GPIO16: https://github.com/arendst/Tasmota/issues/3263#issuecomment-427155769</ref><ref>Usable pins with description: https://tasmota.github.io/docs/Peripherals/#usable-pins</ref><ref>Boot modes and corresponding pin pulling: https://tasmota.github.io/docs/Expanding-Tasmota/#boot-modes</ref>
 
==== ADC/GPIO17 ====
 
==== ADC/GPIO17 ====
−
Note that the analog in is 0-1V maximum; use a voltage divider to limit its input (also see [https://tasmota.github.io/docs/ADC/ the Tasmota ADC] and [https://tasmota.github.io/docs/Commands/#adcparam calibration/tuning] pages).
+
Note that the analog in is 0-1V maximum; use a voltage divider to limit its input.<ref>Tasmota ADC: https://tasmota.github.io/docs/ADC/</ref> and <ref>calibration/tuning: https://tasmota.github.io/docs/Commands/#adcparam</ref>
 +
 
 +
==== space state ====
 +
To read a switch without having a corresponding relay one has to remember the default switch action is <code>TOGGLE</code>, which can be used in traveler-system (hotelschakeling) style: one can turn the light on with switch 1, turn it off with switch 2 (software) and turn it on with switch 1 again while the switch physically is in a different state.
 +
To change the behavior of the switch, use <code>switchmode</code><ref>Switchmode: https://tasmota.github.io/docs/Buttons-and-Switches/#switchmode</ref>:
 +
<pre>
 +
switchmode 1
 +
restart 1
 +
</pre>
 +
Note that if you need the reverse (switch connects to poweroff), you need <code>switchmode 1</code>.
 +
Also note that <code>restart 1</code> is needed to store the configuration.
  
 
==== multiple switches on the spacestate sensor ====
 
==== multiple switches on the spacestate sensor ====
−
If you want to provide MQTT state for multiple switches without having corresponding relay outputs, you need some rule magic; see [https://tasmota.github.io/docs/Rules/#distinguish-switch1-and-switch2-without-the-use-of-relay1-and-relay2 this rule section] to do so.
+
By default, one can use a single switch/button without a relay set.
 +
If you want to provide MQTT state for multiple switches without having corresponding relay outputs, you need some rule magic;<ref>Distinguish switch 1 and 2 without the use of relay 1 and 2: https://tasmota.github.io/docs/Rules/#distinguish-switch1-and-switch2-without-the-use-of-relay1-and-relay2 this rule section</ref>
 +
<pre>
 +
Rule1 ON switch1#state DO publish ackspace/hackspace/%topic%/stat/RESULT {"POWER1":"%value%"} ENDON
 +
Rule2 ON switch2#state DO publish ackspace/hackspace/%topic%/stat/RESULT {"POWER2":"%value%"} ENDON
 +
Backlog Rule1 1; Rule2 1
 +
</pre>
  
 
==== other devices (switches) ====
 
==== other devices (switches) ====
Line 49: Line 66:
  
 
==== recovery ====
 
==== recovery ====
−
When a device doesn't respond or won't connect to wifi, you might need to [https://tasmota.github.io/docs/Device-Recovery/ trigger recovery mode] by:
+
When a device doesn't respond or won't connect to wifi, you might need to trigger recovery mode<ref>Device recovery: https://tasmota.github.io/docs/Device-Recovery/</ref> by:
 
* power it off for 30 seconds
 
* power it off for 30 seconds
 
* power on 7 times with less than 10 second interval
 
* power on 7 times with less than 10 second interval
 
Note that this only works if <code>SetOption65</code> is <code>0</code> (which one would have disabled if brown-outs occur often.
 
Note that this only works if <code>SetOption65</code> is <code>0</code> (which one would have disabled if brown-outs occur often.
 +
 +
=== links ===
 +
<references/>

Revision as of 08:23, 19 June 2022

Project: Spacestate sensors
Featured: Yes
State Active
Members Xopr
GitHub SpaceAPI-sensors
Description You can't manage what you don't measure
Picture
Spacestate sensors Picture.jpg

This project ties strongly with the MQTT setup (to connect to the SpaceAPI) as it uses Tasmota[1] on ESP devices for feature bang and ease of use.

Note that you're more than welcome to add any sensor (or actuator) that you might see fit for our hackerspace. Think: 3D printer nozzle temperature or filament weight, outside radiation, air quality, motion sensing, window opener and the likes; this project is proof anyone that can handle a screwdriver and PC can do this.

synopsis

Create a modular repository of sensors and outputs to keep an eye on temperatures (and/or other stuff), especially for monitoring the server room, and optionally, the [sl|h|st]ackspace(s), including the space state switch.

intro

After some iterations of the Space state switch and some versions of the Spacestate indicator, some different types of temperature sensors, it was time to make it easy on ourselves: switch to MQTT and use Tasmota[1].

In most cases, an off-the-shelf ESP device will suffice, but since not all devices are not galvanically isolated from mains, it's more practical to use an ESP-12 PCB for things where contacts are bare (like the Space state switch).

Here are the steps to setup such a device

configuring a spacestate sensor from scratch

Most of this (apart from the MQTT configuration) only applies to the Spacestate sensor board (see image); it will setup a pinout template that matches the board.

  • Under Configuration, click Configure Other
  • Paste this template: {"NAME":"ACKsensor","GPIO":[0,0,0,0,0,0,0,0,1,0,0,0,1,1],"FLAG":0,"BASE":18} and check Activate
  • Fill in Device Name (ACKtemp or ACKstate) and Friendly Name 1 (Space state switch or leave as is)
  • Save (will reboot)
  • Click Configure Module
  • Make sure Module type is ACKsensor (0)
  • Set functions for GPIO17 (ADC), GPIO16 (Typically Switch 1 or Button 1) and GPIO12 (DS18x20 which is connected to 3.3v using ~4k7 pull up) [2]
  • Save (will reboot again)
  • Click Configure MQTT
  • Set Host (192.168.1.42), User (temperature or spacestate), Password (currently, only xopr knows these passwords), Topic (temperature, switch or spacestate) and Full Topic (ackspace/hackspace/%topic%/%prefix%/)
  • Save (will reboot yet again)

notes and troubleshooting

GPIO16

Note that this pin is special (it lives on a separate register internally, but more important, its internal pull resistor is to ground (pull-down) [3][4][5]

ADC/GPIO17

Note that the analog in is 0-1V maximum; use a voltage divider to limit its input.[6] and [7]

space state

To read a switch without having a corresponding relay one has to remember the default switch action is TOGGLE, which can be used in traveler-system (hotelschakeling) style: one can turn the light on with switch 1, turn it off with switch 2 (software) and turn it on with switch 1 again while the switch physically is in a different state. To change the behavior of the switch, use switchmode[8]: 

switchmode 1
restart 1

Note that if you need the reverse (switch connects to poweroff), you need switchmode 1. Also note that restart 1 is needed to store the configuration.

multiple switches on the spacestate sensor

By default, one can use a single switch/button without a relay set. If you want to provide MQTT state for multiple switches without having corresponding relay outputs, you need some rule magic;[9] 

Rule1 ON switch1#state DO publish ackspace/hackspace/%topic%/stat/RESULT {"POWER1":"%value%"} ENDON
Rule2 ON switch2#state DO publish ackspace/hackspace/%topic%/stat/RESULT {"POWER2":"%value%"} ENDON
Backlog Rule1 1; Rule2 1

other devices (switches)

Note that the space has a modified sonoff POW (old revision) that allows switching with a regular toggle switch while able to monitor the power usage. It uses the following template: {"NAME":"Dangerous POW","GPIO":[32,160,0,0,0,2592,0,0,224,2656,2688,288,0,0],"FLAG":0,"BASE":6} Note that while the GPIO is 5V relative to GND, it most likely is 225V above earth potential: insulate well and never connect it to your PC.

recovery

When a device doesn't respond or won't connect to wifi, you might need to trigger recovery mode[10] by:

  • power it off for 30 seconds
  • power on 7 times with less than 10 second interval

Note that this only works if SetOption65 is 0 (which one would have disabled if brown-outs occur often.

links

  1. ↑ 1.0 1.1 Tasmota homepage: https://tasmota.github.io/
  2. ↑ GPIO-Conversion: https://tasmota.github.io/docs/GPIO-Conversion/
  3. ↑ Github comment on GPIO16: https://github.com/arendst/Tasmota/issues/3263#issuecomment-427155769
  4. ↑ Usable pins with description: https://tasmota.github.io/docs/Peripherals/#usable-pins
  5. ↑ Boot modes and corresponding pin pulling: https://tasmota.github.io/docs/Expanding-Tasmota/#boot-modes
  6. ↑ Tasmota ADC: https://tasmota.github.io/docs/ADC/
  7. ↑ calibration/tuning: https://tasmota.github.io/docs/Commands/#adcparam
  8. ↑ Switchmode: https://tasmota.github.io/docs/Buttons-and-Switches/#switchmode
  9. ↑ Distinguish switch 1 and 2 without the use of relay 1 and 2: https://tasmota.github.io/docs/Rules/#distinguish-switch1-and-switch2-without-the-use-of-relay1-and-relay2 this rule section
  10. ↑ Device recovery: https://tasmota.github.io/docs/Device-Recovery/
Retrieved from "https://ackspace.nl/w/index.php?title=Spacestate_sensors&oldid=9298"