mysCellar - README

 Summary
 =======
 
   Description
   CAV-01 - Flooding detection
   CAV-02 - Temperature measure
   CAV-03 - Humidity measure
   CAV-04 - Door opening
   Arduino pins
   Interactions

-----------------------------------------------------------------------
 Description
 ===========

 The mysCellar sensor is an Arduino Nano-based MySensors v 2.1x sensor.

 It sends to the controller:
 - the current temperature
 - the current humidity rate
 - the current flood sensor analog value
 - an alert when the door is opened or closed
 - an alert when the cellar is flooded.

 Current temperature, humidity rate and flood sensor analog values, later
 said "measures" are only sent when changed, but not more than the
 configurable 'max_frequency'.

 Flood and door alarms, later said "alarms" are sent as soon as they are
 detected.

 If they do not change, measure and alarm status are periodically re-sent
 on a configurable 'unchanged' timeout.

-----------------------------------------------------------------------
 CAV-01 - Flooding detection
 ===========================

  Composants:
  - Foliar rain sensor module sensitive sensor module (AliExpress USD 0.91)
  - Arduino Nano (AliExpress EUR 2.91 x 5)

    [1] The rain sensor detects water that completes the circuits on
        its sensor boards' printed leads. The sensor board acts as a
        variable resistor that will change from 100k ohms when wet to
        2M ohms when dry. In short, the wetter the board the more
        current that will be conducted.
    [2] Connect the 5V power supply , power indicator light , sensor 
        board does not drop when , DO output is high , the switch lights
        off , dripping a drop of water , DO output is low , the switch
        indicator light,

  Though the detection is quasi-immediate, returning to the normal state
  leads to many bounces. In order to prevent these bounces to trigger
  false alerts, the sensor is automatically unarmed after an alarm has
  been triggered.
  The sensors then auto-rearms itself after a configurable 'auto_rearm'
  delay.

  The flood sensor has two indicator lights:
  - whether the sensor is armed (added in v 6.0.2017),
  - whether an alarm has been trigerred (added in v 6.0.2017);
    this later light stays On until the alarm is rearmed.

    Nano output:
    - VCC 5v to sensor
    - GND

    Nano input
    - logical D0 (from HIGH=dry to LOW=wet) -> D4 [D4]
    - analog A0 (from 1023=dry to 0=soak)   -> ADC7 (analog only) [A7]
    - logical D5 (output) : whether the alarm has been tripped
    - logical D6 (output) : whether the alarm is armed

[1] http://www.instructables.com/id/Arduino-Modules-Rain-Sensor/
[2] http://www.aliexpress.com/snapshot/6826183159...
    http://www.aliexpress.com/item/Free-Shipping-2sets-Foliar-rain-sensor-module-sensitive-sensor-module/1801852999.html

-----------------------------------------------------------------------
 CAV-02 - Temperature measure
 CAV-03 - Humidity measure
 ============================

  Composants:
  - DHT22 Digital For Arduino AM2302 Temperature and Humidity Sensor Module (AliExpress USD 4.48)
    One-Wire: single serial bi-directional

    Nano output:
    - VCC 5v to sensor
    - GND

    Nano input
    - one-wire single serial

[1] http://www.aliexpress.com/snapshot/6826183160.html
    http://fr.aliexpress.com/item/Free-Shipping-DHT22-Digital-For-Arduino-AM2302-Temperature-and-Humidity-Sensor-Module/32292804849.html
[2] http://www.electroschematics.com/11291/arduino-dht22-am2302-tutorial-library/

I2C Logic Level Converter Bi-Directional Module 5V to 3.3V For Arduino (AliExpress USD 1.22)

NRF24L01+ Wireless Module 2.4G Wireless Communication Module (AliExpress USD 0.67 x 10)
http://www.aliexpress.com/snapshot/6830181791.html

W5100 Ethernet module Ethernet network module for arduino (AliExpress USD 6.65)
http://fr.aliexpress.com/item/Free-shipping-W5100-Ethernet-module-Ethernet-network-module-for-arduino/2027367160.html

-----------------------------------------------------------------------
 CAV-04 - Door opening
 =====================

 The sensor is provided by the Telemecanique door switch.
 This is a double-relais platine, with a NO and a NC contacts.
 The NC contact is used by origin for lights.
 We are using here the NO contact for the door opening detector:
 - door closed : contact is closed
 - door opened: contact is opened.

 A 10k resistor is connected to get the opening detection.

 The opening sensor has one indicator light:
 - whether the door is opened (A1).

-----------------------------------------------------------------------
 Arduino pins
 ============

  D1/TX:
  D0/RX:
  RST:
  GND:
  D2/INT0:          radio module IRQ
  D3:       (input) temp-hygro sensor SDA output
  D4:       (input) rain sensor digital output
  D5:      (output) rain sensor alarm tripped
  D6:      (output) rain sensor alarm armed
  D9:               radio module CE
  D10/CSN:          radio module CSN
  D11/MOSI:         radio module MOSI
  D12/MISO:         radio module MISO
  D13/SCK:          radio module SCK
  3.3V:             radio module VCC
  A0:               door opening detection
  A1:      (output) door opening detection tripped
  A7:       (input) rain sensor analog output
  5V:               rain sensor VCC
                   +temp-hygro sensor VCC
  GND:              rain sensor GND
                   +temp-hygro sensor GND
                   +radio module GND
                   +door opening detection GND
                   +alimentation GND
  VIN:              alimentation +5v

-----------------------------------------------------------------------
 Interactions
 ============

 Starting with v6.1.2017, this MySensors node presents one ID for each
 message sent to the controller.

 Below interactions are seen from MySensors node point of view.

 Cf. original (and source and reference) in build/Sheets.ods

-----------------------------------------------------------------------
 P. Wieser - Created on 2017, may 2nd
             Last updated on 2025, sept. 27th