Rewrote readme

This commit is contained in:
Gregor Riepl 2020-08-25 01:03:37 +02:00
parent af5a8b5263
commit f4be05ee50
2 changed files with 71 additions and 28 deletions

28
README
View file

@ -1,28 +0,0 @@
Matemat
=======
The Matemat is a vending machine for carbonated soft drinks.
All hardware and software was designed by members of
(Chaostreff Basel)[1] and released in the form of circuit
diagrams, printed circuit board layouts and source code
for anyone to use and modify.
Under certain restrictions, even commercial exploitation is
permissible. Please see the accompanying LICENSE file for
details.
The name "Matemat" is a portmanteau of "mate" (as in mate
tea) and "automat" (the German word for vending machine).
The device is mainly intended to dispense mate tea based
soft drinks, but may be used for other types of beverages
too.
To build the first prototype, an old vending machine with
a cooled bottle compartment was repurposed.
The software source code can be (downloaded separately)[2].
[1] http://www.chaostreff.ch
[2] https://github.com/onitake/matecontrol

71
README.md Normal file
View file

@ -0,0 +1,71 @@
# Matemat
The Matemat is a vending machine for carbonated soft drinks.
It is based on an old vending machine with all its
electronics replaced by new custom-build circuit boards.
All hardware and software was designed by members of
(CCC Basel)[http://www.ccc-basel.ch] and released in the
form of circuit diagrams, printed circuit board layouts
and source code for anyone to use and modify. Refer to
the LICENSE file for details.
The name "Matemat" is a portmanteau of "mate" (as in mate
tea) and "automat" (the German word for vending machine).
The device is mainly intended to dispense mate tea based
soft drinks, but may be used for other types of beverages
too.
## Structure
The heart of the vending machine is a Raspberry Pi
model 3 or later, witch a custom CAN interface board
on its GPIO header.
See (CAN Hat)[https://github.com/onitake/canhat] for
more information.
## Modules
The Matemat components are highly modular. Individual
circuits are connected by CAN bus, and can be extended
as needed.
### drive
Single-motor driver.
Attached directly to each bottle release mechanism.
Requires only power supply wires for the motor and the
CAN bus line.
### power
Motor driver board and power supply.
Alternative to the drive board. Uses the existing machine
wiring instead of power + CAN.
### control
Old central control board. Obsolete.
### feedback
End switch feedback interface.
Senses the status of the end switches and sends CAN bus
messages on changes.
### poweriface
Interface between CAN bus and power board.
### sensor
Environment sensor interface.
### wiring
Wring schema of the old vending machine.