IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

Commit ce9f6bbb authored by Alfredo Herrera's avatar Alfredo Herrera
Browse files

initial commit


Signed-off-by: Alfredo Herrera's avatarAlfredo Herrera <alfredo.herrera@ieee.org>
parent 512952ef
# ignore the following files in this directory
# except for the following
!.gitignore
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>uvclight-air-germicide</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>
###### Copyright (C) 2020 IEEE-Ottawa SIGHT
###### CERN Open Hardware Licence Version 2 - Permissive
# Change Log
All notable changes to this project will be documented in this file. Including: Recommended groupings for changes include:
```diff
+ Added, + Changed, + Deprecated, + Removed, + Fixed, + Security
+
```
The format is based on [Keep a Changelog](http://keepachangelog.com/).
## [Unreleased]
### Added
### Changed
- README.md updates
## [0.0.1] 2020-May-09
### Added
- CONTRIBUTORS.md and CHANGELOG.md files
### Changed
- README.md to reflect new directory structure and use of README.md files on repos
- Added reference to files and publication for original open source project that the UV-light Sanitizer is based on
## *[0.0.0]* 2020-March-23
### Added
- Inported initial files, based on https://github.com/SmallTomatoes/Headlamp
### Changed
- Updated README.md based on existing readme.txt file
<!--stackedit_data:
eyJoaXN0b3J5IjpbMTM1MTc4Njk4MCwyMzI5NTA2MTJdfQ==
-->
\ No newline at end of file
###### Copyright (C) 2020 IEEE-Ottawa SIGHT
###### CERN Open Hardware Licence Version 2 - Permissive
# Contributing
This project is public and licensed under a [CERN Open Hardware Licence Version 2 - Permissive](https://ohwr.org/cern_ohl_p_v2.txt) license. You have the freedom to use, study, modify, share and distribute this project under those conditions.
When contributing to this repository, consider to first discuss the change you wish to make by creating an issue on this repository before making a change; it may save you some time and effort.
Please note that this projects adheres to IEEE's [code of conduct](https://www.ieee.org/content/dam/ieee-org/ieee/web/org/about/ieee_code_of_conduct.pdf), we count on you to follow it in all your interactions with the project. Instances of abusive, harassing, or otherwise unacceptable behavior shall be reported to [supportcenter@ieee.org](mailto:supportcenter@ieee.org).
## Pull Request Process
1. It is recommended that you refer to the [Git SCM](https://git-scm.com) webpage to chose the git client sw you will use. Out instructions assume you are using [gitbash](https://www.git-scm.com/book/en/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Bash) or its equivalent.
2. Get a copy of the project and change its default alias to "upstream":
```
git clone https://opensource.ieee.org/ieee-ottawa-sight/uvclight-air-germicide
git cd ucvlight-air-germicide
git remote -v
git remote rename origin upstream
git checkout master
```
3. add your own repository under the defaul alias "origin" and save there the copy of the "upstream" repository:
```
git remote add origin https://opensource.ieee.org/<<-YOUR-USERID->>/uvclight-air-germicide
git push origin master
```
4. each time you may want to synchronize your copy of the repository with the "upstream" repository:
```
git fetch upstream
git checkout master
git rebase upstream/master
git push -f origin master
```
5. If you want to prepare some changes to merge with the "upstream" repository, first creat a branch and later create a merge request:
```
git checkout -b <<-MY-BRANCH-NAME->>
# add any new files or modify existing source
git add <<-MY-NEW-OR-UPDATED-FILE->>
git commit -m "My great contriution to this project is ..." -s
git push origin <<-MY-BRANCH-NAME->>
```
6. Ensure any install or build dependencies are removed before pushing the changes.
7. Update the necessary README.md files with details of the changes; this includes new environment variables, references to Issues, useful file locations and parameters needed to invoque a build that will use the changes (helps for debugging or studying the change).
8. Increase the version numbers in the CHANGELOG.md, any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
9. All contributions must be done using a merge request to allow for review.
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
### Our Collaborative space
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
### Scope
This pledge applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
### Attribution
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
###### Copyright (C) 2020 IEEE-Ottawa SIGHT
###### CERN Open Hardware Licence Version 2 - Permissive
## UV-Light Sanitizer example contributors (sorted alphabetically)
#### [Tanya Gachovska, Ph.D., P.Eng.](https://opensource.ieee.org/)
* Technical lead
#### [Alfredo Herrera](https://opensource.ieee.org/alfredo.herrera)
* EDA/CAD validation (default maintainer)
* Project lead (default reporter)
### [Full contributors list](url)
\ No newline at end of file
CERN Open Hardware Licence Version 2 - Permissive
Preamble
CERN has developed this licence to promote collaboration among
hardware designers and to provide a legal tool which supports the
freedom to use, study, modify, share and distribute hardware designs
and products based on those designs. Version 2 of the CERN Open
Hardware Licence comes in three variants: this licence, CERN-OHL-P
(permissive); and two reciprocal licences: CERN- OHL-W (weakly
reciprocal) and CERN-OHL-S (strongly reciprocal).
The CERN-OHL-P is copyright CERN 2020. Anyone is welcome to use it, in
unmodified form only.
Use of this Licence does not imply any endorsement by CERN of any
Licensor or their designs nor does it imply any involvement by CERN in
their development.
1 Definitions
1.1 'Licence' means this CERN-OHL-P.
1.2 'Source' means information such as design materials or digital
code which can be applied to Make or test a Product or to
prepare a Product for use, Conveyance or sale, regardless of its
medium or how it is expressed. It may include Notices.
1.3 'Covered Source' means Source that is explicitly made available
under this Licence.
1.4 'Product' means any device, component, work or physical object,
whether in finished or intermediate form, arising from the use,
application or processing of Covered Source.
1.5 'Make' means to create or configure something, whether by
manufacture, assembly, compiling, loading or applying Covered
Source or another Product or otherwise.
1.6 'Notice' means copyright, acknowledgement and trademark notices,
references to the location of any Notices, modification notices
(subsection 3.3(b)) and all notices that refer to this Licence
and to the disclaimer of warranties that are included in the
Covered Source.
1.7 'Licensee' or 'You' means any person exercising rights under
this Licence.
1.8 'Licensor' means a person who creates Source or modifies Covered
Source and subsequently Conveys the resulting Covered Source
under the terms and conditions of this Licence. A person may be
a Licensee and a Licensor at the same time.
1.9 'Convey' means to communicate to the public or distribute.
2 Applicability
2.1 This Licence governs the use, copying, modification, Conveying
of Covered Source and Products, and the Making of Products. By
exercising any right granted under this Licence, You irrevocably
accept these terms and conditions.
2.2 This Licence is granted by the Licensor directly to You, and
shall apply worldwide and without limitation in time.
2.3 You shall not attempt to restrict by contract or otherwise the
rights granted under this Licence to other Licensees.
2.4 This Licence is not intended to restrict fair use, fair dealing,
or any other similar right.
3 Copying, modifying and Conveying Covered Source
3.1 You may copy and Convey verbatim copies of Covered Source, in
any medium, provided You retain all Notices.
3.2 You may modify Covered Source, other than Notices.
You may only delete Notices if they are no longer applicable to
the corresponding Covered Source as modified by You and You may
add additional Notices applicable to Your modifications.
3.3 You may Convey modified Covered Source (with the effect that You
shall also become a Licensor) provided that You:
a) retain Notices as required in subsection 3.2; and
b) add a Notice to the modified Covered Source stating that You
have modified it, with the date and brief description of how
You have modified it.
3.4 You may Convey Covered Source or modified Covered Source under
licence terms which differ from the terms of this Licence
provided that:
a) You comply at all times with subsection 3.3; and
b) You provide a copy of this Licence to anyone to whom You
Convey Covered Source or modified Covered Source.
4 Making and Conveying Products
You may Make Products, and/or Convey them, provided that You ensure
that the recipient of the Product has access to any Notices applicable
to the Product.
5 DISCLAIMER AND LIABILITY
5.1 DISCLAIMER OF WARRANTY -- The Covered Source and any Products
are provided 'as is' and any express or implied warranties,
including, but not limited to, implied warranties of
merchantability, of satisfactory quality, non-infringement of
third party rights, and fitness for a particular purpose or use
are disclaimed in respect of any Source or Product to the
maximum extent permitted by law. The Licensor makes no
representation that any Source or Product does not or will not
infringe any patent, copyright, trade secret or other
proprietary right. The entire risk as to the use, quality, and
performance of any Source or Product shall be with You and not
the Licensor. This disclaimer of warranty is an essential part
of this Licence and a condition for the grant of any rights
granted under this Licence.
5.2 EXCLUSION AND LIMITATION OF LIABILITY -- The Licensor shall, to
the maximum extent permitted by law, have no liability for
direct, indirect, special, incidental, consequential, exemplary,
punitive or other damages of any character including, without
limitation, procurement of substitute goods or services, loss of
use, data or profits, or business interruption, however caused
and on any theory of contract, warranty, tort (including
negligence), product liability or otherwise, arising in any way
in relation to the Covered Source, modified Covered Source
and/or the Making or Conveyance of a Product, even if advised of
the possibility of such damages, and You shall hold the
Licensor(s) free and harmless from any liability, costs,
damages, fees and expenses, including claims by third parties,
in relation to such use.
6 Patents
6.1 Subject to the terms and conditions of this Licence, each
Licensor hereby grants to You a perpetual, worldwide,
non-exclusive, no-charge, royalty-free, irrevocable (except as
stated in this section 6, or where terminated by the Licensor
for cause) patent license to Make, have Made, use, offer to
sell, sell, import, and otherwise transfer the Covered Source
and Products, where such licence applies only to those patent
claims licensable by such Licensor that are necessarily
infringed by exercising rights under the Covered Source as
Conveyed by that Licensor.
6.2 If You institute patent litigation against any entity (including
a cross-claim or counterclaim in a lawsuit) alleging that the
Covered Source or a Product constitutes direct or contributory
patent infringement, or You seek any declaration that a patent
licensed to You under this Licence is invalid or unenforceable
then any rights granted to You under this Licence shall
terminate as of the date such process is initiated.
7 General
7.1 If any provisions of this Licence are or subsequently become
invalid or unenforceable for any reason, the remaining
provisions shall remain effective.
7.2 You shall not use any of the name (including acronyms and
abbreviations), image, or logo by which the Licensor or CERN is
known, except where needed to comply with section 3, or where
the use is otherwise allowed by law. Any such permitted use
shall be factual and shall not be made so as to suggest any kind
of endorsement or implication of involvement by the Licensor or
its personnel.
7.3 CERN may publish updated versions and variants of this Licence
which it considers to be in the spirit of this version, but may
differ in detail to address new problems or concerns. New
versions will be published with a unique version number and a
variant identifier specifying the variant. If the Licensor has
specified that a given variant applies to the Covered Source
without specifying a version, You may treat that Covered Source
as being released under any version of the CERN-OHL with that
variant. If no variant is specified, the Covered Source shall be
treated as being released under CERN-OHL-S. The Licensor may
also specify that the Covered Source is subject to a specific
version of the CERN-OHL or any later version in which case You
may apply this or any later version of CERN-OHL with the same
variant identifier published by CERN.
7.4 This Licence shall not be enforceable except by a Licensor
acting as such, and third party beneficiary rights are
specifically excluded.
\ No newline at end of file
Hello world
\ No newline at end of file
###### Copyright (C) 2020 IEEE-Ottawa SIGHT
###### CERN Open Hardware Licence Version 2 - Permissive
# UV-C light air germicide
The New Coronavirus (COVID-19) pandemic has been contracted by millions of people around the world. At the time of writing, there were no drugs or vaccines authorized to prevent, treat or cure COVID-19. Without an effective remedy against COVID-19, returning to the routines of life we had before the pandemic is not realistic; adapting to the “new normal” while minimizing the risk of becoming infected will be difficult because health and safety concerns will impose restrictions.
Our proposed solution applies to confined spaces like work places, daycares, restaurants and service desks. It addresses the need to complement chemical agents like hand sanitizer, hand soap and disinfectant wipes. Using complementary cleaning approaches will reduce the risks of contagion in these locations.
[far Ultra-Violet-C light (207-222 nm)](https://www.nature.com/articles/s41598-018-21058-w) irradiation successfully disinfects water and air when used at close range. The transparency of air and water makes them a good medium to UV-light sanitation. In a [2006 publication](https://pubmed.ncbi.nlm.nih.gov/17002634/) we read that UV treatment of SARS-CoV significantly decreases the quantity of virus in a given volume in blood (virus titer) after 20 minutes of irradiation; while 40 minutes of irradiation inactivates the virus to the limit of detection. Based on this and other publications, we establish that UV irradiation complementing chemical agents will improve disinfection in confined spaces.
The proposed UV-C light air germicide design aims to be safely used in confined area while occupied; it shall provide a highly efficient and safe portable stationary system by complyin with:
* Official IEEE Open Source HW status
* Official regulatory approvals
* Official Open Source Hardware Association certification
Join us: contributions are welcome.
## Directory structure:
* The project directory structure includes this README.md file and sub-directories.
* Each top directory has a README.md file describing its contents, sub-directories may also have a README.md file.
* Each directory has a **.gitignore** file to identify temporary files not meant to be added to the repository; empty directories include the .gitignore file to preserve the directory structure of the project template.
* The directory structure represents activity areas, under which work (source files) is organised. For example:
**[uvclight-air-germicide]** top-level directory with designand project folders and README.md file
* README.md project description and status
* CHANGELOG.md design changes, project changes, versions and releases
* CONTRIBUTORS.md active members list, past contributors list
* CONTRIBUTING.md instructions on how to contribute to the project
* LICENSE Project license, there may be more details in the [project]/[legal] sub-directory
**[design]** sub-directory with folders for design files
**[project]** sub-directory for project management files
# ignore the following files in this directory
# except for the following
!.gitignore
# ignore the following files in this directory
# except for the following
!.gitignore
# ignore the following files in this directory
# except for the following
!.gitignore
# ignore the following files in this directory
# except for the following
!.gitignore
# ignore the following files in this directory
# except for the following
!.gitignore
# ignore the following files in this directory
# except for the following
!.gitignore
# ignore the following files in this directory
# except for the following
!.gitignore
###### Copyright (C) 2020 IEEE-Ottawa SIGHT
###### CERN Open Hardware Licence Version 2 - Permissive
# UV-C Light surface sanitizer design development
This design is based on a transistor-blocking oscillator circuit powering a [far Ultra-Violet-C light (207-222 nm)](https://www.nature.com/articles/s41598-018-21058-w) LED from a battery.
This design is made available to anyone so that they can make, modify, distribute, and use the [Open Source Hardware](https://www.oshwa.org/definition/) design source files.
## Directory structure:
* This sub-directory is a template for design development files.
* It includes this README.md file and a .gitignore listing what should not be added to repository.
* The directories structure represents activity as follows:
* [bin] bash/make scripts, toolchain/CAD, data files
* [doc] Requirements, specifications, references, BoM
* [1_model] octave/matlab, FEM analysis SW (e.g. ONELAB, Elmer, Netgen/NGSolve), NEC analysis SW (e.g. 4NEC2, NEC2++)
* [2_mech] FreeCAD, LibreCAD, TinkerCAD, SketchUp
* [3_elechw] Oregano/Ngspice, Icarus/Verilator, GHDL
* [4_pcb] KiCAD, Eagle PCB, TinyCAD
* [5_sw-app] C, Java, Assembler code
* [6_sys-int] Verification plan, System bring-up, System Integration instructions
* [misc] miscelaneous
## Design development process:
# ignore the following files in this directory
*.sh
start-stop_vm.sh
Toolchain_Linux.tar.gz
rv32m1_sdk_riscv_installer.sh
# except for the following
!.gitignore
# ===========================================================================
# Copyright (C) 2014 IEEE SIGHT, HIC-Ottawa
# (https://drive.google.com/a/ieee.org/folderview?id=0B95p3CkC_rRkRm5HY09pUzNfVlU&usp=sharing)
#
# This shared folder has files related to the Open Source - Avalanche
# Radar Imaging System (OS-ARIS), including licenses to use for
# under IEEE's Open Source Humanitarian Engineering Licensing
# Protocol (OS-HELP).
#
# The contents of this file are subject to the terms of the Creative
# Commons BY-SA License, v. 4.0. If a copy of the CC BY-SA
# was not distributed with this folder contents, you can obtain one
# at http://creativecommons.org/licenses/by-sa/4.0/.
# ---------------------------------------------------------------------------
# $Author: alfredo.herrera@ieee.org$
# $Date: 2014-April-10$
# $Name: alfredoh1234$
# ===========================================================================
The design files in the sub-directories show design details of: (i) an open source
werable ligh (headlamp) (ii) for medical personnel in rural communities (iii) that
lack electricity. The design features resilience as a way to attain extreme
durability and to reduce life cycle impacts. For sustainability, the design uses
widely available components and a flexible hardware platform that will be conducive
to open source development to enable the use of locally sourced materials and local
skilled labour.
The electrical part of the system uses one AA NiMH battery, a 1 Watt LED, and
a voltage-boost circuit. This design is available as open source hardware from
the IEEE.
# ===========================================================================
# $Author: alfredo.herrera@ieee.org$
# $Date: 2014-April-05$
# $Name: alfredoh1234$
# ===========================================================================
# Change History
# ---------------------------------------------------------------------------
# $Revision: 0.1 $
# $Log: $
#
# ===========================================================================
\ No newline at end of file
# ignore the following files in this directory
# except for the following
!.gitignore
# ignore the following files in this directory
# except for the following
!.gitignore
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment