README: document project

This commit is contained in:
King Kévin 2020-12-16 19:36:43 +01:00
parent 78fff2ed0f
commit f808195452
1 changed files with 78 additions and 11 deletions

View File

@ -1,4 +1,4 @@
This firmware template is designed for development boards based around [STM32 F4 series micro-controller](https://www.st.com/en/microcontrollers-microprocessors/stm32f4-series.html).
This is the firmware for the yeast raiser.
project
=======
@ -6,29 +6,96 @@ project
summary
-------
*describe project purpose*
The purpose is to grow and train a yeast culture in a sourdough started.
The yeast will multiply on its own, but the optimum temperature is 30 - 35 °C.
A heater will keep the temperature around 32.5 °C.
This will also allow to have similar condition to measure the yeast's efficiency over time.
The device with also monitor the sourdough starter rising under the activity of the yeast.
technology
----------
*described electronic details*
A small glass (e.g. 350 mL) is used to make a sourdough starter.
board
=====
To make a starter:
The underlying template also supports following board:
1. mix 50 g of flour and 50g of water (whole wheat flour contains generally more yeast and bacteria since there is more of the grain's shell)
2. leave it in the glass for 24h
3. mix 50 g of this starter with 50 g of flour and 50 g of water
4. repeat from step 2 until the starter is rising twice its original size after a couple of hours
5. mix 10 g of this starter with 50 g of flour and 50 g of water
6. leave it for a couple of hours until it's falling back in
7. you can keep it in the fridge for a couple of days (maximum until a gray liquid layer is forming)
8. repeat from step 5
- [WeAct MiniF4](https://github.com/WeActTC/MiniF4-STM32F4x1), based on a STM32F401CCU6
A heater is used to keep the glass above 30 °C.
The heater is made out of a lid fitting the glass, so the glass fits perfectly on top of it.
A 5 Ohm 10 W ceramic resistor is epoxy glued in the lid.
A DS18B20 sensor is placed next to it to monitor it's temperature.
The thermometer is used to prevent the lid from over-heating.
**Which board is used is defined in the Makefile**.
This is required to map the user LED and button provided on the board
The top lid of the glass if equipped with the following:
- a 10 kOhm thermistor in a stainless steel tube, to measure the starter's temperature once plunged into it
- a HC-SR04 ultrasonic range sensor, to measure the starter's rising
- a MLX90614 infra-red thermometer, to measure the starter's temperature without contact, as alternative to the thermocouple
- a n-channel MOSFET, to power the power resistor in the heater
- a SSD1306 0.96 inch OLED display, to show the starter's temperature and growth
- a STM32F401-based [WeAct MiniF4](https://github.com/WeActTC/MiniF4-STM32F4x1) development board, to control all peripherals
To use the yeast raiser:
1. put the lid on the empty glass
2. power the board, through the USB-C, USB micro-B, or OD 5.5 mm/ID 2.1 mm barrel jack, using a 5 V 1 A power supply
3. the screen should display a message
4. press on the button, which will measure the height of the glass
5. prepare the sourdough starter in the glass
6. put back the lid on, inserting the thermistor in the starter
7. press on the button, which will measure the height of the initial started
8. the yeast raiser will continuously monitor and display the height and temperature of the sourdough starter
9. it will heat the starter to 30 - 35 °C, until it falls back
10. it will show when, and how high the starter was when it reached its peak
connections
===========
Connect the peripherals the following way (STM32F4xx signal; STM32F4xx pin; peripheral pin; peripheral signal; comment):
Connect the peripherals the following way.
- *list board to peripheral pin connections*
button (if not already present on the development board):
1. ground
2. PA0
power n-channel MOSFET:
1. gate: PB12, pulled up by 100 kO resistor to 5V
2. drain: power resistor for heated bed
3. source: ground
HC-SR04 ultrasonic range sensor:
1. ground
2. echo: PB9
3. trigger: PB8
4. VCC: 5V
DS18B20 1-Wire temperature sensor:
1. ground
2. 1-Wire: PB10, pulled up by 1 kO resistor to 5V
3. VCC: 5V
SSD1306 OLED display module:
1. gound
2. VDD: 3.3V
3. SCK: PB6/I2C1_SCL, pulled up by 10-47 kO resistor to 3.3V
4. SDA: PB7/I2C1_SDA, pulled up by 10-47 kO resistor to 3.3V
10 kOhm NTC thermistor:
1. ground
2. PA6, pulled to to 3.3V by 10 kOhm resistor
MLX90614 IR-thermometer:
1. VIN: 3.3V
2. GND: ground
3. SCL: PA8/I2C3_SCL
4. SDA: PB4/I2C3_SDA
All pins are configured using `define`s in the corresponding source code.