diff --git a/src_docs/source/compiling.rst b/src_docs/source/compiling.rst index 25e92ad..2f3c243 100644 --- a/src_docs/source/compiling.rst +++ b/src_docs/source/compiling.rst @@ -29,14 +29,9 @@ In the platformio config there are 3 targets defined * gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled. * gravity-release; Standard release -* gravity-perf; Standard release but contains code for measuring performance. -* gravity32-release: Version for ESP32. -* gravity32-perf: Version for ESP32 but contains code for measuring performance. - -.. note:: - There is an experimental ESP32 target but since platformio only supports SDK 1.0.6 and the WIFI connection is really slow compared to ESP8266, - so the recommendation is to wait for support on 2.0.x branch. With the tested version an wifi connection takes 3-8s on a ESP32 compared - to 0.5s on an ESP8266. There is also a bug in OneWire connected to ESP32 that has not been fixed in the main repository yet. +* gravity32-release: Version for ESP32 mini. +* gravity32-c3-release: Version for ESP32 C3 mini. +* gravity32-s2-release: Version for ESP32 S2 mini. .. warning:: The debug target can be unstable and crash the device under certain circumstanses. Excessive logging to the serial port can cause corruption and crashes. diff --git a/src_docs/source/hardware.rst b/src_docs/source/hardware.rst index 10be3ac..8785ed5 100644 --- a/src_docs/source/hardware.rst +++ b/src_docs/source/hardware.rst @@ -3,36 +3,64 @@ Hardware ######## -There are lots of resouces out there on how to build the hardware for an iSpindle so I will not go into details on that part. Here are two of my builds using the iSpindle PCB v4. +iSpindle based on esp8266 +========================= -.. image:: images/ispindel.jpg +There are lots of resouces out there on how to build the hardware for an iSpindle so I will not go into details on that part. I typically use one of the +excellent pcb boards that, for example the iSpindel PCB v4.0 from Cherry Philip. Here is one of my standard builds using an esp8266. + +.. image:: images/ispindel_esp8266.jpg :width: 500 - :alt: Builds of iSpindel - -It's possible to use this PCB and mount an ESP32 on top of that. It must be an pin compatible ESP32 and the one I used was called *ESP32 d1 mini*. Since this is the same width as the PCB you need to -mount it really close to the PCB in order for it to fit in the PET tube/container. I also had to smooth the edge of the ESP32 in order for it to fit. - -I would suggest that you try how it fits into the PET tube before soldering it to the PCB. Make sure that the battery is attached since this will be a really tight fit. - -You also need to desolder (remove) the RED ON LED from the ESP32 or the battery power will be reduced a lot. - -Final thing is to add a resistor between A0 (Analog PIN) and ground of 470k. The reason is that the esp8266 has a build in resistor which -the esp32 does not have. So in order to get a valid voltage (less than 3.2V) on the A0 pin this is needed. Once the modification is done you might -need to adjust the voltage factor so the battery reading is correct. - -.. image:: images/esp32.jpg - :width: 500 - :alt: Mounting esp32 + :alt: iSpindle esp8266 Schema for esp8266 build ------------------------- +++++++++++++++++++++++++ .. image:: images/schema_esp8266.png :width: 700 :alt: Schema esp8266 +iSpindle based on esp32 +======================= + +I've experimented with porting my software version to esp32 and this is a selection of options i have been testing. + +.. image:: images/esp32_hardware.jpg + :width: 500 + :alt: iSpindle esp32 hardware options + +* esp32 mini, this was the first board i tried which is a smaller form factor of the first generetion esp32 with 2 cores. Slow on connecting to wifi is the main downside. +* esp32c3 mini, a newer version based on the latest risc v7 architecture, is seen as the replacement for the esp8266 with bluetooth support. +* esp32s2 mini, similar to the c3 board but without bluetooth support. + +It's possible to use this PCB and mount an ESP32 mini on top of that (c3 and s2 are prefeered). The esp32 mini is a larger formfactor and can be hard to fit into the tube. + +.. note:: + You need to add a resistor between A0 (Analog PIN) and ground of 470k. The reason is that the esp8266 has a build in resistor for a voltage divider + which the esp32 does not have. So in order to get a valid voltage (less than 3.2V) on the A0 pin this is needed. Once the modification is done you might + need to adjust the voltage factor so the battery reading is correct. + +ESP32c3 mini +++++++++++++ + +Work in progress... + +ESP32s2 mini +++++++++++++ + +Work in progress... + +ESP32 mini +++++++++++ + +I would suggest that you try how it fits into the PET tube before soldering it to the PCB. Make sure that the battery is attached since this will be a really tight fit. + +.. image:: images/ispindel_esp32.jpg + :width: 500 + :alt: Esp32 mini build + Schema for esp32 build ----------------------- +++++++++++++++++++++++ .. note:: This schema assumes that an ESP32 D1 Mini (pin compatible with ESP8266 D1 Mini is used) @@ -44,8 +72,8 @@ Schema for esp32 build :width: 700 :alt: Schema esp32 -Modifying with reed switch --------------------------- +Adding a reed (magnetic) reset switch +===================================== A reed switch is a switch that reacts to magnetic fields. The ones I have tested are normally open and close in proximity to a magnet. diff --git a/src_docs/source/images/esp32_hardware.jpg b/src_docs/source/images/esp32_hardware.jpg new file mode 100644 index 0000000..e839c25 Binary files /dev/null and b/src_docs/source/images/esp32_hardware.jpg differ diff --git a/src_docs/source/images/esp32_mini.jpg b/src_docs/source/images/esp32_mini.jpg new file mode 100644 index 0000000..f511621 Binary files /dev/null and b/src_docs/source/images/esp32_mini.jpg differ diff --git a/src_docs/source/images/esp32c3_mini.jpg b/src_docs/source/images/esp32c3_mini.jpg new file mode 100644 index 0000000..6ab278a Binary files /dev/null and b/src_docs/source/images/esp32c3_mini.jpg differ diff --git a/src_docs/source/images/esp32s2_mini.jpg b/src_docs/source/images/esp32s2_mini.jpg new file mode 100644 index 0000000..82b3cec Binary files /dev/null and b/src_docs/source/images/esp32s2_mini.jpg differ diff --git a/src_docs/source/images/esp8266.jpg b/src_docs/source/images/esp8266.jpg new file mode 100644 index 0000000..4eb738c Binary files /dev/null and b/src_docs/source/images/esp8266.jpg differ diff --git a/src_docs/source/images/ispindel.jpg b/src_docs/source/images/ispindel.jpg deleted file mode 100644 index 783b6d2..0000000 Binary files a/src_docs/source/images/ispindel.jpg and /dev/null differ diff --git a/src_docs/source/images/ispindel_esp32.jpg b/src_docs/source/images/ispindel_esp32.jpg new file mode 100644 index 0000000..8994fe2 Binary files /dev/null and b/src_docs/source/images/ispindel_esp32.jpg differ diff --git a/src_docs/source/images/ispindel_esp8266.jpg b/src_docs/source/images/ispindel_esp8266.jpg new file mode 100644 index 0000000..fbded59 Binary files /dev/null and b/src_docs/source/images/ispindel_esp8266.jpg differ diff --git a/src_docs/source/images/ispindel_pcb4.jpg b/src_docs/source/images/ispindel_pcb4.jpg new file mode 100644 index 0000000..2b6b308 Binary files /dev/null and b/src_docs/source/images/ispindel_pcb4.jpg differ diff --git a/src_docs/source/releases.rst b/src_docs/source/releases.rst index 6aed2d9..143eebf 100644 --- a/src_docs/source/releases.rst +++ b/src_docs/source/releases.rst @@ -3,6 +3,17 @@ Releases ######## +v1.2.0 - beta1 +============== + +Features +++++++++ +* Added support for the ESP32 C3 mini board + +Issues adressed +++++++++++++++++ +* BUG: The first portion of a format template was lost when doing conversion. + v1.1.0 ======