AmboVent proyect

AmboVent proyect to FreeCAD part
This commit is contained in:
BERSERK 2020-07-02 19:20:34 -05:00
parent e63fd80f5b
commit a96375239f
3 changed files with 128 additions and 0 deletions

View file

@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <https://unlicense.org>

View file

@ -0,0 +1,104 @@
# AmboVent 1690.108
Automatic, Controlled Resuscitator Device
Emergency ventilation alternative system
Global Partnership for the Greater good
Leading Open Source Code Mentality Initiative
## Emergency ventilation initiative coming out of Israel
## The device was not tested yet for its performance or safety; it is NOT approved for clinical use
### Who is behind it?
**Lead by the CTO & innovation leader of the Israeli Air-Force 108 Electronic Depot and backed by a large community of innovators behind him, to include:**
1. 40 Professional Volunteers
1. Magen David Adom (Israels national EMS)
1. Physicians from leading Israeli hospitals such as Tel Aviv Sourasky and Hadassah JLM as well as other medical centers, Engineers, FIRST Israel mentors and students
1. The Haifa Technological Center Rafael
1. Israel Aerospace Industries
1. IAF Unit 108
1. The garage program by Microsoft Israel
1. IDC Herzeliya
1. and others...
## Developer Chat on Gitter:
[![Gitter](https://badges.gitter.im/AmboVent-Ventilator/community.svg)](https://gitter.im/AmboVent-Ventilator/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## [AmboVent Website](https://1nn0v8ter.rocks/AmboVent-1690-108)
## [BOM list](https://docs.google.com/spreadsheets/d/1yqxRhruZpR-hO4cpbX6UkSeXTlXk1JLd_4aYDwuWj4k/edit?usp=sharing)
# AmboVent's Standard Copyright and Disclaimer Notice:
*Copyright ©2020. THE AMBOVENT GROUP FROM ISRAEL herby declares: No Rights Reserved. Anyone in the world have Permission to use, copy, modify, and distribute this software and its documentation for educational, research, for profit, business and not-for-profit purposes, without fee and without a signed licensing agreement, all is hereby granted, provided that the intention of the user is to use this code and documentation to save human lives anywhere in the world. For any question, contact dreliram@gmail.com.*
***IN NO EVENT SHALL THE AMBOVENT GROUP FROM ISRAEL, BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THESE SPECS, LIST OF MATERIALS, ELECTRONIC DESIGNS , SOFTWARE CODE AND ANY DOCUMENTATION, EVEN IF THE AMBOVENT GROUP FROM ISRAEL HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
THE AMBOVENT GROUP FROM ISRAEL DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE AND ACCOMPANYING DOCUMENTATION, SPECS, LIST OF MATERIALS, ELECTRONIC DESIGNS, SOFTWARE CODE AND ANY DOCUMENTATION IF PROVIDED HEREUNDER IS PROVIDED "AS IS". THE AMBOVENT GROUP FROM ISRAEL HAS NO CLAIM THAT IT IS COMPLETED OR FUNCTIONAL AND HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.***
# Setup
## Software
1. (Required to build the code): [Arduino IDE](https://www.arduino.cc/en/Main/Software)
1. (Optional: recommended to edit the code): Eclipse project for Arduino source code _editing_ (NOT building):
1. A general setup PDF guide can be found in the [eRCaGuy_dotfiles](https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles) project [here](https://github.com/ElectricRCAircraftGuy/eRCaGuy_dotfiles/blob/master/eclipse/Eclipse%20setup%20instructions%20on%20a%20new%20Linux%20(or%20other%20OS)%20computer.pdf). See also:
1. [3-Software/Arduino/readme.md](3-Software/Arduino/readme.md).
1. [3-Software/Arduino/arduino_core/readme.md](3-Software/Arduino/arduino_core/readme.md)
1. [3-Software/Arduino/.clang-format](3-Software/Arduino/.clang-format) - there are some nice descriptions & info in here on Eclipse & Sublime Text 3 editors, as well as setting your Arduino IDE to use 4 spaces instead of 2 for tabs.
1. (Required to get a pull request accepted which modifies the code): `clang-format` automatic code format tool. Please run this on any PR (GitHub Pull Request) before submitting a PR!
1. Linux (tested--works):
1. Install:
# Install it:
sudo apt update
sudo apt install clang-format
# Ensure you have version 6 (the default for Ubuntu 18), for compatibility with
# the .clang-format file we are using; sample output:
# `clang-format version 6.0.0-1ubuntu2 (tags/RELEASE_600/final)`
clang-format --version
1. Use it:
1. Commit your changes so everything is backed up.
1. Then run the clang formatter:
./run_clang-format.sh
1. Then review and commit these changes, if any.
1. Now do a Pull Request.
1. Windows:
1. Install:
1. Download and install [Git for Windows](https://git-scm.com/download/win)
1. Download and install LLVM (which includes `clang-format`) version **6.0.1** (for compatibility--see above) [for Windows, here](https://releases.llvm.org/download.html). Here's a [direct link](https://releases.llvm.org/6.0.1/LLVM-6.0.1-win64.exe) if you like for the 64-bit version.
1. Use it:
1. Using the git bash terminal that comes with git for Windows, run the script:
./run_clang-format.sh
1. Make sure to do this before making any Pull Request (see Linux "Use it" instructions just above as well).
# Software Changelog
- Newest on top
- Follows Semantic Versioning: MAJOR.MINOR.PATCH; see: https://semver.org/ for rules & FAQ.
- The 6 most common recommended types of changes are (see here: https://keepachangelog.com/en/1.0.0/): Added, Changed, Deprecated, Removed, Fixed, Security
INITIAL DEVELOPMENT PHASE:
- Use version numbers 0.MINOR.PATCH for the initial development phase; ex: 0.1.0, 0.2.0, etc.
- Increment just the MINOR version number for each new 0.y.z development phase enhancement, until the project is mature enough that you choose to move to a 1.0.0 release
- You may increment the PATCH number for bug fixes to your development code, or just increment the MINOR version number if there are also enhancements
MORE MATURE PHASE:
- As the project matures, release a 1.0.0 version
- Once you release a 1.0.0 version, do the following (copied from semver.org):
- Given a version number MAJOR.MINOR.PATCH, increment the:
1. MAJOR version when you make incompatible API changes,
2. MINOR version when you add functionality in a backwards compatible manner, and
3. PATCH version when you make backwards compatible bug fixes.
## [v0.1.0] - 2020-04-22
- Added: changelog and started tracking a software "version" number via the changelog
- Fixed: continued incremental improvements of the software formatting and style: ex: moved global variables to their own lines