[docs] added a first device page

If we like this one I will go ahead and convert the rest.
2026-07-27 19:57:38 +00:00 · 2018-11-19 15:55:07 +01:00
parent 375274b208
commit 84caa6939c
7 changed files with 167 additions and 38 deletions
@@ -1,22 +1,97 @@
+.. ESP Easy colors (set in cutom.css)
+.. role:: blue
+.. role:: red
+.. role:: green
+.. role:: yellow
+.. role:: orange
+.. role:: cyan
+.. role:: purple
+
 .. _P052_S8_page:

 S8
-**
+==
+
+:cyan:`Gases - CO2 Senseair`
+
+.. image:: images\\P052_S8_1.jpg

 Introduction
 ------------
-The Senseair plugin can be used for multiple gas sensors from the company Senseair. The mostly used sensor is the S8 but other sensor units that work is tSense (K70), K30, K33, S8 (and soon LP8).
+
+The Senseair plugin can be used for multiple gas sensors from the company Senseair. The mostly used sensor
+is the S8 but other sensor units that work is tSense (K70), K30, K33, S8 (and soon LP8).

 Wiring
 ------

+Circuit wiring (S8 seen from PCB side, with the 5 vias down and the 4 vias up):
+
+.. code-block:: html
+
+    ESP               S8
+    GPIO (7)   <-->   TX (3rd via [middle] of the 5 vias)
+    GPIO (8)   <-->   RX (4th via [right of TX])
+
+    Power
+    5.0V       <-->   VCC (4th via of the 4 vias, 300 mA peak/30 mA average)
+    GND        <-->   GND (3rd via [left of VCC])
+
+Set up the S8 according to this simple schematics. If you want to take extra precautions you should add 47R
+resistor or similar to the TX and RX signals (this is not used in the pictures below). In this example we
+use the Wemos D1 mini as the host of the 5V input to the S8 and connect the Wemos to USB for power.
+
+.. danger::
+  PLEASE OBSERVE THAT FEEDING THE S8 WITH 5.2+V WILL DAMAGE THE INTERNAL LAMP AND BREAK THE UNIT - GIVING FALSE VALUES!
+
 Setup
 -----

+Set up the device according to:
+
+1st GPIO: :blue:`GPIO-13 (D7)`
+
+2st GPIO: :blue:`GPIO-15 (D8)`
+
+Sensor: :blue:`Carbon Dioxide`
+
 Rules examples
 --------------

+.. code-block:: html
+
+ on CO2#Level do
+  if [CO2#Level]>2000
+    Publish,%sysname%/Alarm,CO2 level is too high!
+  endif
+ endon
+
 Indicators (recommended settings)
 ---------------------------------

+.. csv-table::
+   :header: "Indicator", "Value Name", "Interval", "Decimals", "Extra information"
+   :widths: 8, 5, 5, 5, 40
+
+   "Status", "N/A", "", "", ""
+   "Carbon Dioxide", "ppm", "15", "0", ""
+   "Temperature", "N/A", "", "", "Used for tSense (K70), K30, K33"
+   "Humidity", "N/A", "", "", "Used for tSense (K70), K30, K33"
+
 Where to buy
+------------
+
+.. csv-table::
+   :header: "Store", "Link"
+   :widths: 5, 40
+
+   "AliExpress","`Link 1 <http://s.click.aliexpress.com/e/cg1fhDDI>`_ `Link 2 <https://test.com>`_"
+   "Ebay","`Link 3 <http://rover.ebay.com/rover/1/711-53200-19255-0/1?ff3=4&pub=5575404073&toolid=10001&campid=5338336929&customid=&mpre=https%3A%2F%2Fwww.ebay.com%2Fitm%2FS8-0053-carbon-dioxide-infrared-CO2-sensors-FOR-SenseAir%2F112303432827%3Fhash%3Ditem1a25ce647b%3Ag%3A%7EHcAAOSw1WJZJ%7E8Y>`_"
+   "First Byte","`Link 4 <https://firstbyte.shop/products/s8>`_"
+
+More pictures
+-------------
+
+.. image:: images\\P052_S8_2.jpg
+
+.. image:: images\\P052_S8_3.jpg
@@ -24,7 +24,7 @@ There's three different released versions of ESP Easy:

 .. csv-table::
   :header: "Plugin number", "Plugin status", "Plugin name", "Used by", "GitHub link", "Comment"
-   :widths: 5, 8, 30, 15, 20, 40
+   :widths: 5, 8, 30, 15, 30, 40

   "P001",":green:`NORMAL`",":cyan:`Switch Input - Switch`","","`P001_Switch.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P001_Switch.ino>`_",""
   "P002",":green:`NORMAL`",":cyan:`Analog Input - Internal`","","`P002_ADC.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P002_ADC.ino>`_",""
@@ -66,26 +66,26 @@ There's three different released versions of ESP Easy:
   "P038",":green:`NORMAL`",":cyan:`Output - NeoPixel (Basic)`","","`P038_NeoPixel.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P038_NeoPixel.ino>`_",""
   "P039",":green:`NORMAL`",":cyan:`Environment - Thermocouple`","","`P039_Thermocouple.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P039_Thermocouple.ino>`_",""
   "P040",":green:`NORMAL`",":cyan:`RFID - ID12LA/RDM6300`","","`P040_ID12.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P040_ID12.ino>`_",""
-   "P041",":green:`NORMAL`",":cyan:`Output`","","`P041_NeoClock.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P041_NeoClock.ino>`_",""
-   "P042",":green:`NORMAL`",":cyan:`Output`","","`P042_Candle.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P042_Candle.ino>`_",""
-   "P043",":green:`NORMAL`",":cyan:`Output`","","`P043_ClkOutput.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P043_ClkOutput.ino>`_",""
-   "P044",":green:`NORMAL`",":cyan:`Communication`","","`P044_P1WifiGateway.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P044_P1WifiGateway.ino>`_",""
-   "P045",":green:`NORMAL`",":cyan:`Gyro`","","`P045_MPU6050.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P045_MPU6050.ino>`_",""
-   "P046",":yellow:`TESTING`",":cyan:`Hardware`","","`P046_VentusW266.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P046_VentusW266.ino>`_","This one is suppressed by default, you need to compile your own version if you want to use it."
-   "P047",":yellow:`TESTING`",":cyan:`Environment`","","`P047_i2c-soil-moisture-sensor.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P047_i2c-soil-moisture-sensor.ino>`_",""
-   "P048",":yellow:`TESTING`",":cyan:`Motor`","","`P048_Motorshield_v2.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P048_Motorshield_v2.ino>`_","Adafruit Motorshield"
-   "P049",":green:`NORMAL`",":cyan:`Gases`","","`P049_MHZ19.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P049_MHZ19.ino>`_",""
-   "P050",":red:`DEVELOPMENT`",":cyan:`Color`","","`P050_TCS34725.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P050_TCS34725.ino>`_",""
-   "P051",":yellow:`TESTING`",":cyan:`Environment`","","`P051_AM2320.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P051_AM2320.ino>`_",""
-   "P052",":green:`NORMAL`",":cyan:`Gases`",":ref:`P052_S8_page`","`P052_SenseAir.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P052_SenseAir.ino>`_",""
-   "P053",":yellow:`TESTING`",":cyan:`Dust`","","`P053_PMSx003.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P053_PMSx003.ino>`_",""
-   "P054",":yellow:`TESTING`",":cyan:`Communication`","","`P054_DMX512.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P054_DMX512.ino>`_",""
-   "P055",":yellow:`TESTING`",":cyan:`Notify`","","`P055_Chiming.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P055_Chiming.ino>`_",""
-   "P056",":red:`DEVELOPMENT`",":cyan:`Dust`","","`P056_SDS011-Dust.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P056_SDS011-Dust.ino>`_",""
-   "P057",":yellow:`TESTING`",":cyan:`Display`","","`P057_HT16K33_LED.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P057_HT16K33_LED.ino>`_",""
-   "P058",":yellow:`TESTING`",":cyan:`Keypad`","","`P058_HT16K33_KeyPad.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P058_HT16K33_KeyPad.ino>`_",""
-   "P059",":green:`NORMAL`",":cyan:`Switch input`","","`P059_Encoder.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P059_Encoder.ino>`_",""
-   "P060",":yellow:`TESTING`",":cyan:`Analog input`","","`P060_MCP3221.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P060_MCP3221.ino>`_",""
+   "P041",":green:`NORMAL`",":cyan:`Output - NeoPixel (Word Clock)`","","`P041_NeoClock.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P041_NeoClock.ino>`_",""
+   "P042",":green:`NORMAL`",":cyan:`Output - NeoPixel (Candle)`","","`P042_Candle.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P042_Candle.ino>`_",""
+   "P043",":green:`NORMAL`",":cyan:`Output - Clock`","","`P043_ClkOutput.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P043_ClkOutput.ino>`_",""
+   "P044",":green:`NORMAL`",":cyan:`Communication - P1 Wifi Gateway`","","`P044_P1WifiGateway.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P044_P1WifiGateway.ino>`_",""
+   "P045",":green:`TESTING`",":cyan:`Gyro - MPU 6050`","","`P045_MPU6050.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P045_MPU6050.ino>`_",""
+   "P046",":yellow:`TESTING`",":cyan:`Hardware - Ventus W266`","","`P046_VentusW266.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P046_VentusW266.ino>`_","This one is suppressed by default, you need to compile your own version if you want to use it."
+   "P047",":yellow:`TESTING`",":cyan:`Environment - Soil moisture sensor`","","`P047_i2c-soil-moisture-sensor.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P047_i2c-soil-moisture-sensor.ino>`_",""
+   "P048",":yellow:`TESTING`",":cyan:`Motor - Adafruit Motorshield v2`","","`P048_Motorshield_v2.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P048_Motorshield_v2.ino>`_","Adafruit Motorshield"
+   "P049",":green:`NORMAL`",":cyan:`Gases - CO2 MH-Z19`","","`P049_MHZ19.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P049_MHZ19.ino>`_",""
+   "P050",":red:`DEVELOPMENT`",":cyan:`Color - TCS34725`","","`P050_TCS34725.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P050_TCS34725.ino>`_",""
+   "P051",":yellow:`TESTING`",":cyan:`Environment - AM2320`","","`P051_AM2320.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P051_AM2320.ino>`_",""
+   "P052",":green:`NORMAL`",":cyan:`Gases - CO2 Senseair`",":ref:`P052_S8_page`","`P052_SenseAir.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P052_SenseAir.ino>`_",""
+   "P053",":yellow:`TESTING`",":cyan:`Dust - PMSx003`","","`P053_PMSx003.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P053_PMSx003.ino>`_",""
+   "P054",":yellow:`TESTING`",":cyan:`Communication - DMX512 TX`","","`P054_DMX512.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P054_DMX512.ino>`_",""
+   "P055",":yellow:`TESTING`",":cyan:`Notify - Chiming`","","`P055_Chiming.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P055_Chiming.ino>`_",""
+   "P056",":red:`DEVELOPMENT`",":cyan:`Dust - SDS011/018/198`","","`P056_SDS011-Dust.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P056_SDS011-Dust.ino>`_",""
+   "P057",":yellow:`TESTING`",":cyan:`Display - HT16K33`","","`P057_HT16K33_LED.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P057_HT16K33_LED.ino>`_",""
+   "P058",":yellow:`TESTING`",":cyan:`Keypad - HT16K33`","","`P058_HT16K33_KeyPad.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P058_HT16K33_KeyPad.ino>`_",""
+   "P059",":green:`NORMAL`",":cyan:`Switch input - Rotary Encoder`","","`P059_Encoder.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P059_Encoder.ino>`_",""
+   "P060",":yellow:`TESTING`",":cyan:`Analog input - MCP3221`","","`P060_MCP3221.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P060_MCP3221.ino>`_",""
   "P061",":yellow:`TESTING`",":cyan:`Keypad`","","`P061_KeyPad.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P061_KeyPad.ino>`_",""
   "P062",":yellow:`TESTING`",":cyan:`Keypad`","","`P062_MPR121_KeyPad.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P062_MPR121_KeyPad.ino>`_",""
   "P063",":green:`NORMAL`",":cyan:`Keypad`","","`P063_TTP229_KeyPad.ino <https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P063_TTP229_KeyPad.ino>`_",""
@@ -189,7 +189,7 @@ boot/reboot/time/sleep etc. of the unit:
   :widths: 10, 30, 15

   "
-   <taskname>#<valuename>
+   ``<taskname>#<valuename>``
   ","
   As described already, each task can produced one or more events, one for each measured value. You should not name your devices and value names so that the combination equals to any of the below listed system events!
   ","
@@ -202,7 +202,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   System#Wake
+   ``System#Wake``
   ","
   Triggered after power on.
   ","
@@ -215,7 +215,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   System#Boot
+   ``System#Boot``
   ","
   Triggered at boot time.
   ","
@@ -229,7 +229,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   System#Sleep
+   ``System#Sleep``
   ","
   Triggered just before the ESP goes to deep sleep.
   ","
@@ -242,7 +242,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   MQTT#Connected
+   ``MQTT#Connected``
   ","
   Triggered when the ESP has connected to broker.
   ","
@@ -255,7 +255,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   MQTT#Disconnected
+   ``MQTT#Disconnected``
   ","
   Triggered when the ESP has disconnected from the broker.
   ","
@@ -268,7 +268,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   MQTTimport#Connected
+   ``MQTTimport#Connected``
   ","
   Triggered when the ESP has connected to broker (the MQTT Import plugin uses a separate connection than the generic one).
   ","
@@ -281,7 +281,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   MQTTimport#Disconnected
+   ``MQTTimport#Disconnected``
   ","
   Triggered when the ESP has disconnected from the broker (the MQTT Import plugin uses a separate connection than the generic one).
   ","
@@ -294,7 +294,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   WiFi#Connected
+   ``WiFi#Connected``
   ","
   Triggered when the ESP has connected to Wi-Fi.
   ","
@@ -307,7 +307,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   WiFi#ChangedAccesspoint
+   ``WiFi#ChangedAccesspoint``
   ","
   Triggered when the ESP has changed to access point, will also trigger first time the unit connects to the Wi-Fi.
   ","
@@ -320,7 +320,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   Login#Failed
+   ``Login#Failed``
   ","
   Triggered when (someone) has tried to login to a ESP unit with admin password enabled, but have failed to enter correct password.
   ","
@@ -333,7 +333,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   Time#Initialized
+   ``Time#Initialized``
   ","
   Triggered the first time (after boot) NTP is updating the unit.
   ","
@@ -346,7 +346,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   Time#Set
+   ``Time#Set``
   ","
   Triggered when the time is set by an update from NTP.
   ","
@@ -360,7 +360,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   Rules#Timer=
+   ``Rules#Timer=``
   ","
   As described already, triggered when a rules timer ends (setting a timer to 0 will disable the timer).
   ","
@@ -373,7 +373,7 @@ boot/reboot/time/sleep etc. of the unit:

   "
   "
-   Clock#Time=
+   ``Clock#Time=``
   ","
   Triggered every minute with day and time like: Mon,12:30 or Tue,14:45. You can define triggers on specific days or all days using 'All' for days indicator. You can also use wildcards in the time setting like All,**:00 to run every hour.
   ","
@@ -40,3 +40,57 @@
  padding: 4px 7px;
  border-radius: 3px;
 }
+.reference.external {
+  border-style: solid;
+  border-color: #3492E2;
+  color: #3492E2;
+  padding: 4px 7px;
+  border-radius: 3px;
+  box-shadow: 1px 1px 1px grey;
+}
+.reference.external:hover {
+  background-color: #3492E2;
+  color: #FFFFFF;
+}
+img {
+    max-width: 100%;
+    height: auto;
+    border-radius: 20px;
+    background-color: white;
+    box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19);
+    margin-bottom: 15px;
+}
+h2 {
+  background-color: #3492E2;
+  color: #FFFFFF;
+  font-size: 20px;
+  padding: 4px 7px;
+}
+h3 {
+  background-color: #3492E2;
+  color: #FFFFFF;
+  font-size: 15px;
+  padding: 4px 7px;
+}
+h4 {
+  background-color: #A8A8A8;
+  color: #000000;
+  font-size: 15px;
+  padding: 4px 7px;
+  margin-left: 10px;
+}
+.headerlink {
+  color: #FFFFFF;
+}
+td, th {
+    border-bottom: : 1px solid #ddd;
+    padding: 8px;
+}
+tr:nth-child(even){background-color: #F2F2F2;}
+tr:hover {background-color: #ddd;}
+th {
+    padding-top: 12px;
+    padding-bottom: 12px;
+    text-align: left;
+    color: black;
+}