Dispensy/README.md

Dispensy

One day aims to be a new hardware base for the DrinkRobotics UbaBot.

Check out the Dispensy documentation.

License

This hardware of this project is licensed under the CERN Open Hardware Licence Version 2 - Strongly Reciprocal (CERN-OHL-S-2.0+) or any later version. The SSD1306 footprint is from KiCAD Rookie.

The docs are built using mdbook, licensed as MPL-2.0. The PCB SVG files in the documentation are displayed using svg-pan-zoom, licensed as BSD-2-Clause. The 3D PCB files in the documentation are displayed using three.js, licensed as MIT.

Please also take a look at the README.md files in the subfolders of this project for more info.

 ------------------------------------------------------------------------------
| Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
|                                                                              |
| This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
| or any later version.                                                        |
|                                                                              |
| You may redistribute and modify this source and make products using it under |
| the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
| or any later version.                                                        |
|                                                                              |
| This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
| INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
| PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
| for applicable conditions.                                                   |
|                                                                              |
| Source location: https://github.com/drinkrobotics/dispensy                   |
|                                                                              |
| As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
| source, You must where practicable maintain the Source Location visible      |
| on the external case of the Gizmo or other products you make using this      |
| source.                                                                      |
 ------------------------------------------------------------------------------

The firmware of this project is licensed as GPLv3. I initially adapted it from my own Trackball and Volcano Remote projects. It uses the Pi Pico SDK, licensed as BSD 3-clause, and therefore also TinyUSB, licensed under the MIT license. Some code is adapted from the TinyUSB examples. To control the OLED display, pico-ssd1306 is used, licensed under the MIT license. The CAN bus PIO implementation is can2040, licensed under the GPLv3. Repo metadata is embedded into the project using cmake-git-version-tracking, licensed under the MIT license.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

See <http://www.gnu.org/licenses/>.