├── CNAME ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── LICENSE-hardware ├── README.md ├── _config.yml ├── index.md ├── simmel-concept.png ├── simmel-desk.jpg ├── simmel-rear.jpg ├── simmel-usb.jpg ├── simmel_assembled.jpg ├── simmel_lanyard.jpg ├── simmel_pcb_quarter1.jpg ├── simmel_pcb_sideview.jpg ├── simmel_pen_compare.jpg ├── simmel_plugged_in.jpg └── tt-token-comparison_titled.jpg /CNAME: -------------------------------------------------------------------------------- 1 | simmel.betrusted.io -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. 6 | 7 | We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. 8 | 9 | ## Our Standards 10 | 11 | Examples of behavior that contributes to a positive environment for our community include: 12 | 13 | * Demonstrating empathy and kindness toward other people 14 | * Being respectful of differing opinions, viewpoints, and experiences 15 | * Giving and gracefully accepting constructive feedback 16 | * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience 17 | * Focusing on what is best not just for us as individuals, but for the overall community 18 | 19 | Examples of unacceptable behavior include: 20 | 21 | * The use of sexualized language or imagery, and sexual attention or 22 | advances of any kind 23 | * Trolling, insulting or derogatory comments, and personal or political attacks 24 | * Public or private harassment 25 | * Publishing others' private information, such as a physical or email 26 | address, without their explicit permission 27 | * Other conduct which could reasonably be considered inappropriate in a 28 | professional setting 29 | 30 | ## Enforcement Responsibilities 31 | 32 | Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. 33 | 34 | Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. 35 | 36 | ## Scope 37 | 38 | This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. 39 | 40 | ## Enforcement 41 | 42 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at conduct@kosagi.com. All complaints will be reviewed and investigated promptly and fairly. 43 | 44 | All community leaders are obligated to respect the privacy and security of the reporter of any incident. 45 | 46 | ## Enforcement Guidelines 47 | 48 | Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: 49 | 50 | ### 1. Correction 51 | 52 | **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. 53 | 54 | **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. 55 | 56 | ### 2. Warning 57 | 58 | **Community Impact**: A violation through a single incident or series of actions. 59 | 60 | **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. 61 | 62 | ### 3. Temporary Ban 63 | 64 | **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. 65 | 66 | **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. 67 | 68 | ### 4. Permanent Ban 69 | 70 | **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. 71 | 72 | **Consequence**: A permanent ban from any sort of public interaction within the project community. 73 | 74 | ## Attribution 75 | 76 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, 77 | available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 78 | 79 | Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). 80 | 81 | [homepage]: https://www.contributor-covenant.org 82 | 83 | For answers to common questions about this code of conduct, see the FAQ at 84 | https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. 85 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Contributions are welcome! 4 | 5 | Contributions can be bug reports, feature requests, testing and documentation 6 | in addition to code. Please see the github guide on 7 | [Collaborating on projects using issues and pull requests](https://help.github.com/categories/collaborating-on-projects-using-issues-and-pull-requests/) for details. 8 | 9 | Contributions to this project are accepted on an 10 | ["inbound=outbound"](https://opensource.com/law/11/7/trouble-harmony-part-1) basis. 11 | That means that you agree that your contributions are made under the 12 | same license as the license for this project (found in this directory in the [LICENSE](LICENSE) file). 13 | 14 | To make this understanding explicit -- and for you to assert 15 | that you have the right to make the contribution -- commits must be 16 | signed off indicating acceptance of the 17 | [Developer Certificate of Origin 1.1](https://developercertificate.org/). 18 | A nice explanation of the DCO has been provided by 19 | [Karl Fogel](https://www.red-bean.com/kfogel/) 20 | in his excellent book [Producing Open Source Software](https://producingoss.com/en/contributor-agreements.html#developer-certificate-of-origin). 21 | An explanation of the "sign-off" procedure is given by 22 | [Linus Torvalds](https://en.wikipedia.org/wiki/Linus_Torvalds) in [Linux](https://github.com/torvalds/linux/blob/master/Documentation/process/submitting-patches.rst#11-sign-your-work---the-developers-certificate-of-origin). 23 | 24 | ## Code of Conduct 25 | 26 | Please note that this project is released with a 27 | [Contributor Code of Conduct](CODE_OF_CONDUCT.md) 28 | (adopted from the [Contributor Covenant v2.0](https://www.contributor-covenant.org/)). 29 | 30 | By participating in this project you agree to abide by the 31 | [Contributor Code of Conduct](CODE_OF_CONDUCT.md) 32 | (please read the full text so that you can understand what actions will and 33 | will not be tolerated). 34 | 35 | ## Contribution Workflow 36 | 37 | This is an overview of the contribution workflow: 38 | 39 | * Fork the repository on Github 40 | * Create a topic branch from where you want to base your work (usually from the master branch) 41 | * Check the formatting rules from existing code (no trailing whitespace, mostly default indentation) 42 | * Ensure any new code is well-tested, and if possible, any issue fixed is covered by one or more new tests 43 | * Make commits to your branch using the following guidelines: 44 | * Start with a subject line (beginning with a capital, ending without a period, no more than 50 characters) 45 | * The second line should be blank 46 | * The body starts on the third line and may 47 | [reference existing issues](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords) 48 | (e.g. `Closes #1`) 49 | * Use the imperative mood in the subject line: "Add x", "Fix y", "Support z", "Remove x" 50 | * Wrap the body at 72 characters 51 | * Use the body to explain what and why vs. how 52 | * Finish the commit message with the sign off: `Signed-off-by: Your Name ` 53 | * Push your code to your fork of the repository 54 | * Make a Pull Request 55 | 56 | ## Emacs 57 | 58 | Are you an Emacs user? If so you can use `magit-commit-popup` 59 | (from [magit](https://magit.vc/)) to add these 60 | commit options for you: 61 | * **-s** Add Signed-off-by line (--signoff) 62 | * **=S** Sign using gpg (--gpg-sign="0xCAFED00D") -- *this is extra credit* 63 | 64 | Did you know that Emacs can delete trailing whitespace without 65 | you *every having to think about it*? Just add this to your 66 | Emacs configuration: 67 | 68 | ```` 69 | (add-hook 'before-save-hook 'delete-trailing-whitespace) 70 | ```` 71 | 72 | ## Verified commits with GPG 73 | 74 | Verifying commits is not essential for contributions to this project, 75 | but for those motivated to add additional security it is important 76 | to know that Github now [supports GPG signature verification](https://github.com/blog/2144-gpg-signature-verification). 77 | 78 | Using GPG is a complex subject. Here are some pointers for further information: 79 | * [OpenPGP Best Practices](https://help.riseup.net/en/security/message-security/openpgp/best-practices) 80 | * [Debian Keysigning HOWTO](https://wiki.debian.org/Keysigning) 81 | * If you create a new key please ensure that the RSA key length is at least 82 | 4096 bits and configured for [SHA-2](https://www.debian-administration.org/users/dkg/weblog/48) 83 | * If you use **caff** (from [signing-party](https://packages.debian.org/sid/signing-party)) to sign and distrubute signatures please verify that the *separate* [caff configuration is accurate](https://github.com/tmarble/kspsig). 84 | 85 | You can export your GPG public key to a file for use with Github as follows 86 | (assuming your GPG key id is 0xCAFED00D): 87 | 88 | ```` 89 | gpg --output 0xCAFED00D.asc --armor --export-options export-clean,export-minimal --export 0xCAFED00D 90 | ```` 91 | 92 | Simply paste the contents of that file in the **SSH and GPG keys** section of your [Github settings](https://help.github.com/articles/adding-a-new-gpg-key-to-your-github-account/). 93 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /LICENSE-hardware: -------------------------------------------------------------------------------- 1 | CERN OHL v1.2 2 | 2013-09-06 - CERN, Geneva, Switzerland 3 | CERN Open Hardware Licence v1.2 4 | 5 | Preamble 6 | Through this CERN Open Hardware Licence ("CERN OHL") version 1.2, CERN wishes to provide a tool to foster collaboration and sharing among hardware designers. The CERN OHL is copyright CERN. Anyone is welcome to use the CERN OHL, in unmodified form only, for the distribution of their own Open Hardware designs. Any other right is reserved. Release of hardware designs under the CERN OHL does not constitute an endorsement of the licensor or its designs nor does it imply any involvement by CERN in the development of such designs. 7 | 8 | 1. Definitions 9 | In this Licence, the following terms have the following meanings: 10 | “Licence” means this CERN OHL. 11 | “Documentation” means schematic diagrams, designs, circuit or circuit board layouts, mechanical drawings, flow charts and descriptive text, and other explanatory material that is explicitly stated as being made available under the conditions of this Licence. The Documentation may be in any medium, including but not limited to computer files and representations on paper, film, or any other media. 12 | “Documentation Location” means a location where the Licensor has placed Documentation, and which he believes will be publicly accessible for at least three years from the first communication to the public or distribution of Documentation. 13 | “Product” means either an entire, or any part of a, device built using the Documentation or the modified Documentation. 14 | “Licensee” means any natural or legal person exercising rights under this Licence. 15 | “Licensor” means any natural or legal person that creates or modifies Documentation and subsequently communicates to the public and/ or distributes the resulting Documentation under the terms and conditions of this Licence. 16 | A Licensee may at the same time be a Licensor, and vice versa. 17 | Use of the masculine gender includes the feminine and neuter genders and is employed solely to facilitate reading. 18 | 19 | 2. Applicability 20 | 2.1. This Licence governs the use, copying, modification, communication to the public and distribution of the Documentation, and the manufacture and distribution of Products. By exercising any right granted under this Licence, the Licensee irrevocably accepts these terms and conditions. 21 | 2.2. This Licence is granted by the Licensor directly to the Licensee, and shall apply worldwide and without limitation in time. The Licensee may assign his licence rights or grant sub-licences. 22 | 2.3. This Licence does not extend to software, firmware, or code loaded into programmable devices which may be used in conjunction with the Documentation, the modified Documentation or with Products, unless such software, firmware, or code is explicitly expressed to be subject to this Licence. The use of such software, firmware, or code is otherwise subject to the applicable licence terms and conditions. 23 | 24 | 3. Copying, modification, communication to the public and distribution of the Documentation 25 | 3.1. The Licensee shall keep intact all copyright and trademarks notices, all notices referring to Documentation Location, and all notices that refer to this Licence and to the disclaimer of warranties that are included in the Documentation. He shall include a copy thereof in every copy of the Documentation or, as the case may be, modified Documentation, that he communicates to the public or distributes. 26 | 3.2. The Licensee may copy, communicate to the public and distribute verbatim copies of the Documentation, in any medium, subject to the requirements specified in section 3.1. 27 | 3.3. The Licensee may modify the Documentation or any portion thereof provided that upon modification of the Documentation, the Licensee shall make the modified Documentation available from a Documentation Location such that it can be easily located by an original Licensor once the Licensee communicates to the public or distributes the modified Documentation under section 3.4, and, where required by section 4.1, by a recipient of a Product. However, the Licensor shall not assert his rights under the foregoing proviso unless or until a Product is distributed. 28 | 3.4. The Licensee may communicate to the public and distribute the modified Documentation (thereby in addition to being a Licensee also becoming a Licensor), always provided that he shall: 29 | a) comply with section 3.1; 30 | b) cause the modified Documentation to carry prominent notices stating that the Licensee has modified the Documentation, with the date and description of the modifications; 31 | c) cause the modified Documentation to carry a new Documentation Location notice if the original Documentation provided for one; 32 | d) make available the modified Documentation at the same level of abstraction as that of the Documentation, in the preferred format for making modifications to it (e.g. the native format of the CAD tool as applicable), and in the event that format is proprietary, in a format viewable with a tool licensed under an OSI-approved license if the proprietary tool can create it; and 33 | e) license the modified Documentation under the terms and conditions of this Licence or, where applicable, a later version of this Licence as may be issued by CERN. 34 | 3.5. The Licence includes a non-exclusive licence to those patents or registered designs that are held by, under the control of, or sub-licensable by the Licensor, to the extent necessary to make use of the rights granted under this Licence. The scope of this section 3.5 shall be strictly limited to the parts of the Documentation or modified Documentation created by the Licensor. 35 | 36 | 4. Manufacture and distribution of Products 37 | 4.1. The Licensee may manufacture or distribute Products always provided that, where such manufacture or distribution requires a licence under this Licence the Licensee provides to each recipient of such Products an easy means of accessing a copy of the Documentation or modified Documentation, as applicable, as set out in section 3. 38 | 4.2. The Licensee is invited to inform any Licensor who has indicated his wish to receive this information about the type, quantity and dates of production of Products the Licensee has (had) manufactured 39 | 40 | 5. Warranty and liability 41 | 5.1. DISCLAIMER – The Documentation and any modified Documentation 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 the Documentation, the modified Documentation or any Product. The Licensor makes no representation that the Documentation, modified Documentation, or any Product, does or will not infringe any patent, copyright, trade secret or other proprietary right. The entire risk as to the use, quality, and performance of a Product shall be with the Licensee 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. The Licensee warrants that it does not act in a consumer capacity. 42 | 5.2. LIMITATION OF LIABILITY – The Licensor shall 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 Documentation, modified Documentation and/or the use, manufacture or distribution of a Product, even if advised of the possibility of such damages, and the Licensee 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. 43 | 44 | 6. General 45 | 6.1. Except for the rights explicitly granted hereunder, this Licence does not imply or represent any transfer or assignment of intellectual property rights to the Licensee. 46 | 6.2. The Licensee shall not use or make reference to any of the names (including acronyms and abbreviations), images, or logos under which the Licensor is known, save in so far as required to comply with section 3. Any such permitted use or reference shall be factual and shall in no event suggest any kind of endorsement by the Licensor or its personnel of the modified Documentation or any Product, or any kind of implication by the Licensor or its personnel in the preparation of the modified Documentation or Product. 47 | 6.3. CERN may publish updated versions of this Licence which retain the same general provisions as this version, but differ in detail so far this is required and reasonable. New versions will be published with a unique version number. 48 | 6.4. This Licence shall terminate with immediate effect, upon written notice and without involvement of a court if the Licensee fails to comply with any of its terms and conditions, or if the Licensee initiates legal action against Licensor in relation to this Licence. Section 5 shall continue to apply. 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | index.md -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-minimal 2 | title: Simmel Project 3 | description: Simmel is a wearable platform that enables COVID-19 contact tracing while preserving user privacy. 4 | logo: simmel-concept.png 5 | -------------------------------------------------------------------------------- /index.md: -------------------------------------------------------------------------------- 1 | ## Simmel 2 | 3 | Simmel is a platform that enables COVID-19 contact tracing while 4 | preserving user privacy. It is a wearable hardware beacon and scanner 5 | which can broadcast and record randomized user IDs. Contacts are stored 6 | within the wearable device, so you retain full control of your trace 7 | history until you choose to share it. 8 | 9 | ![Simmel diagram](https://github.com/simmel-project/frontpage/raw/master/simmel-concept.png) 10 | 11 | The Simmel design is open source, so you are empowered to audit the 12 | code. Furthermore, once the pandemic is over, you are able to recycle, 13 | re-use, or securely destroy the device, thanks to the availability of 14 | hardware and firmware design source. 15 | 16 | The contact tracing algorithm is programmed using CircuitPython, to 17 | facilitate ease of code audit and community participation. The Simmel 18 | project does not endorse a specific contact tracing platform, but it is 19 | inherently not compatible with contact tracing proposals that rely on 20 | the constant upload of data to the cloud. 21 | 22 | ### Hardware Summary 23 | The hardware design source for Simmel can be found [here](https://github.com/simmel-project/hardware). The EVT version is based around the [Nordic NRF52833](https://www.nordicsemi.com/Products/Low-power-short-range-wireless/nRF52833). 24 | 25 | ![Simmel overview](https://github.com/simmel-project/frontpage/raw/master/simmel-desk.jpg) 26 | 27 | Simmel is being developed on a very short timeframe. We have two paths 28 | being explored in parallel. 29 | 30 | - The **BLE** variant facilitates contact tracing via BLE. 31 | - The **NUS** variant facilitates contact tracing via near ultrasound 32 | (NUS). 33 | 34 | BLE is a proven, battle-tested technology with mature chipsets and 35 | protocol stacks. Thus it is plausible that a solution could be deployed 36 | at nation-state scales in a matter of months. However, BLE beacon signal 37 | strength is known to be a poor proxy for locality. Furthermore, running 38 | a BLE chipset constantly in scan mode is a relatively power hungry 39 | exercise, driving up battery requirements. 40 | 41 | NUS is a novel proposal which relies on near ultrasound (18-22kHz) 42 | acoustically modulated transmissions to determine proximity. Ultrasound 43 | is fairly directional and does not penetrate walls, so it stands to 44 | reason that a signal detected on NUS is a good indicator of direct 45 | physical proximity. Furthermore, the power cost of sampling a microphone 46 | is less than that of BLE scanning. However, there is no established NUS 47 | protocol. Furthermore, NUS requires transducers that are expensive 48 | compared to BLE parts, and also requires the user to directly wear the 49 | device; we are assuming that e.g. a typical handbag would block the NUS 50 | signal. Thus while NUS may be preferable from a privacy and power 51 | standpoint, it is handicapped by a lack of maturity and higher cost. 52 | 53 | Simmel provisions a 2MiB on-device SPINOR. We anticipate a contact 54 | record to consist of about 96 bytes, which should allow for about 20,000 55 | contacts to be recorded in a circular buffer that expires over a period 56 | of 2-3 weeks (as set by the policy of the contact tracing application). 57 | 58 | ![Simmel rear view](https://github.com/simmel-project/frontpage/raw/master/simmel-rear.jpg) 59 | 60 | ### DVT Hardware Revision 61 | 62 | As of August 2020, Simmel went through a hardware revision to make its 63 | form factor compatible with that of the Singapore TraceTogether token. 64 | Hardware design files can be found at https://github.com/simmel-project/hardware/tree/master/electrical/dvt1. 65 | 66 | ![Simmel DVT vs TraceTogether](https://github.com/simmel-project/frontpage/raw/master/tt-token-comparison_titled.jpg) 67 | 68 | The left board is Simmel DVT, the right board is the Singapore TraceTogether 69 | token. Simmel DVT drops NUS support, but adds an independently battery-backed 70 | real time clock (RTC) so that elapsed time can be kept even when the 71 | main power is removed. Simmel DVT also features a hall-effect (that is, 72 | a magnetically activated) power switch. It's configured so that the PCB 73 | is off so long as the magnet is absent. 74 | 75 | The idea behind Simmel DVT is to provide a fully open source 76 | alternative to the TraceTogether token, that can fit directly into a 77 | TraceTogether token case. The USB-C connector, used only by 78 | developers, fits without modification into the TraceTogether token 79 | shell, and the hall effect on/off switch allows users to turn off 80 | their tokens without having to open the case up, or modify the shell to add 81 | a power switch: instead, one tapes a magnet to the edge of the 82 | shell near the hall effect switch, and when they desire the token to 83 | be off, they may simply remove the magnet. 84 | 85 | One compromise that resulted from fitting everything, including the 86 | USB-C connector, entirely within the outline of the TraceTogether 87 | token PCB is that developers need to use a USB type C extension cable 88 | to plug their boards into a host PC. However, given that developers 89 | are a minority of the users, it's probably the right trade-off to 90 | allow a direct drop-in replacement of the TraceTogether token board 91 | without requiring a case mod for the USB-C connector, versus 92 | positioning the connector so that it protrudes through the case for 93 | convenient developer access, but requiring every subsequent user to 94 | cut a hole in their TraceTogether token case to accommodate a 95 | connector they will never use. 96 | 97 | ### Firmware Summary 98 | 99 | Simmel will run a port of CircuitPython. CircuitPython was chosen oven 100 | an embedded C RTOS for the following reasons: 101 | 102 | - The contact tracing algorithm should be simple enough that it can be 103 | implemented in CircuitPython 104 | - CircuitPython has a lower barrier of entry compared to embedded C 105 | - Code distribution can be done in source form. Provisioning and update 106 | is a matter of plugging the Simmel device into a USB port and copying 107 | the source file into an emulated mass storage device. 108 | - CircuitPython has a baseline port to our BLE chipset family 109 | - Simmel project will fill in the missing drivers, power management, and 110 | cryptographic primitives 111 | 112 | Because of the open and easy nature of firmware update for Simmel, 113 | once the COVID-19 outbreak is over, users can re-use their Simmel devices 114 | for other applications. It is also easy to provision a script that 115 | securely erases the contact tracing ROM, allowing the devices to be 116 | donated to schools or other organizations for extended use after 117 | the outbreak. 118 | 119 | ![Simmel USB connector](https://raw.githubusercontent.com/simmel-project/frontpage/master/simmel-usb.jpg) 120 | 121 | ### Application Code 122 | 123 | Simmel does not endorse a specific contact tracing algorithm at this 124 | time; however, we are basing many of the system design assumption around 125 | support for protocols that are similar to 126 | [Bluetrace](https://bluetrace.io/). The Simmel hardware does not 127 | possess the ability to connect directly to the Internet, and is 128 | therefore incapable of sharing its logging data without user 129 | intervention. 130 | 131 | ### Media 132 | 133 | Below are some images of the initial Simmel prototype as fabricated 134 | using a 3D printer. 135 | 136 | ![Simmel prototype](https://github.com/simmel-project/frontpage/raw/master/simmel_pen_compare.jpg) 137 | 138 | In addition to being packed into a backpack, purse or briefcase, the 139 | simmel device can be hung from a lanyard. 140 | 141 | ![Simmel lanyard](https://github.com/simmel-project/frontpage/raw/master/simmel_assembled.jpg) 142 | 143 | ![Simmel as worn](https://github.com/simmel-project/frontpage/raw/master/simmel_lanyard.jpg) 144 | 145 | Here's a photo of Simmel as plugged into a USB type C socket on a typical laptop. 146 | 147 | ![Simmel plugged in](https://github.com/simmel-project/frontpage/raw/master/simmel_plugged_in.jpg) 148 | 149 | And here are some photos of the Simmel PCBA. 150 | 151 | ![Simmel PCBA](https://github.com/simmel-project/frontpage/raw/master/simmel_pcb_quarter1.jpg) 152 | 153 | ![Simmel PCBA](https://github.com/simmel-project/frontpage/raw/master/simmel_pcb_sideview.jpg) 154 | 155 | ### About the Simmel Project 156 | 157 | The Simmel project was started on April 10, 2020 in response to a 158 | request for a hardware design proposal by NLNet. The simmel-project 159 | GitHub repository's people page [lists the 160 | developers](https://github.com/orgs/simmel-project/people) that have 161 | [elected to reveal their participation 162 | publicly](https://help.github.com/en/articles/publicizing-or-hiding-organization-membership). 163 | 164 | The Simmel project name comes from [Georg 165 | Simmel](https://wikipedia.org/wiki/Georg_Simmel), an early researcher 166 | into sociology and social distance theory. 167 | 168 | The administrative contacts for the Simmel project are: 169 | 170 | * [Andrew 'bunnie' 171 | Huang](https://en.wikipedia.org/wiki/Andrew_Huang_(hacker)) 172 | ([@bunniestudios](https://twitter.com/bunniestudios)/[blog](https://bunniestudios.com)) 173 | * [Sean 'xobs' Cross](https://xobs.io) 174 | 175 | Both contacts are currently at liberty to discuss details and opinions about any contact tracing technology. 176 | 177 | --- 178 | 179 |
180 | 181 | The Simmel team is funded through the [NGI0 PET 182 | Fund](https://nlnet.nl/PET), a fund established by NLnet with financial 183 | support from the European Commission's [Next Generation 184 | Internet](https://ngi.eu/) programme, under the aegis of DG 185 | Communications Networks, Content and Technology under grant agreement No 186 | 825310. 187 | -------------------------------------------------------------------------------- /simmel-concept.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel-concept.png -------------------------------------------------------------------------------- /simmel-desk.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel-desk.jpg -------------------------------------------------------------------------------- /simmel-rear.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel-rear.jpg -------------------------------------------------------------------------------- /simmel-usb.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel-usb.jpg -------------------------------------------------------------------------------- /simmel_assembled.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel_assembled.jpg -------------------------------------------------------------------------------- /simmel_lanyard.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel_lanyard.jpg -------------------------------------------------------------------------------- /simmel_pcb_quarter1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel_pcb_quarter1.jpg -------------------------------------------------------------------------------- /simmel_pcb_sideview.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel_pcb_sideview.jpg -------------------------------------------------------------------------------- /simmel_pen_compare.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel_pen_compare.jpg -------------------------------------------------------------------------------- /simmel_plugged_in.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/simmel_plugged_in.jpg -------------------------------------------------------------------------------- /tt-token-comparison_titled.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/simmel-project/frontpage/d7df80184fb14cafdc241fe432a9c6c077999202/tt-token-comparison_titled.jpg --------------------------------------------------------------------------------