diff --git a/LICENSE b/LICENSE index a3ce17a..cc3e245 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,427 @@ -MIT License +Attribution-ShareAlike 4.0 International -Copyright (c) 2022 XenGi +======================================================================= -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +Using Creative Commons Public Licenses -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 OR COPYRIGHT HOLDERS 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. +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README.md b/README.md index 1703ebf..2c7b14f 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,64 @@ -CAD files -========= +mkbd65 case +=========== -To generate the CAD files for the mkbd65 run the following command: - -``` -./generate_scad.py -``` +_The case for mkbd65 is still a work in progress!_ -Layout files +Generate CAD files +------------------ + +1. Install dependencies + ```shell + pip3 install --user -r requirements.txt + ``` +2. Generate files for your phone for example the Oneplus 8T + ```shell + ./mkbd65.py --layout=ansi --3mf oneplus_8t.ini + ``` + +Build instructions +------------------ + +### 3D printing + +Most of the case can be 3D printed using a home 3D printer, any online 3D printing service or at your local hack/make space. You can find your local hack/make space [here](https://wiki.hackerspaces.org/List_of_Hacker_Spaces). + +Print out these files with a sturdy filament like PLA: + +- `lower_case` + +Print out the `key_mat` with a flexible filament like [FilaFlexible40](https://fila-tech.store/product/filaflexible40). + +Config files ------------ -These files define the layoout that gets printed on the keymat. Currently the only file included is `layout_en_us.py` -for an english US international layout. you can use that as a template for your layout. +Properties for different phones are saved in INI files. Currently the only file included is `oneplus_8t.ini` for the +Oneplus 8T phone. You can add your one phone by providing the INI file with measurements and a file describing it's camera bump. -The file should define a single variable `LAYOUT` which is a list of roaws. These rows are also lists of columns. Each -column has keys, which are a list of the strings that should be printed at different positions. - -Example for a one button keyboard with the labels `foo` in the top left corner and `bar` in the bottom left: - -``` -LAYOUT = [ - [ - ['foo', 'bar', '', '', ''], - ], -] -``` - -The label string will be used as `[TopLeft, BottomLeft, TopRight, BottomRight, Middle]`. - -Some strings need special escaping to be used in OpenScad later on. See the en_us layout for examples. - - -Phone config ------------- - -Properties for different phones are saved in INI files. Currently the only file included is `oneplus5t.ini` for the -Oneplus 5t phone with a english US international layout with the DejaVu Sans font. - -In the config file you can define phone specific aspects and style such as the used font and layout. Here is a list of +In the config file you can define the phones size but also other aspects like the used font for the key mat. Here is a list of the possile options: -| Group | Option | Type | Default | Description | -| ------ | --------- | ------ | ---------------------- | ----------------------------- | -| keymap | thickness | Number | 0.5 | Thickness of the keymap in mm | -| | layout | String | en_us-intl | Layout file used for labels | -| key | thickness | Number | 1 | Thickness of the key in mm | -| | font | String | DejaVu Sans:style=Bold | Font used for labels | +| Group | Option | Type | Default | Description | +| ------- | --------- | ------ | ---------------------- | ----------------------------- | +| keymap | thickness | Number | 0.5 | Thickness of the keymap in mm | +| key_mat | thickness | Number | 1 | Thickness of the key in mm | +| | font | String | DejaVu Sans:style=Bold | Font used for labels | - -OpenScad files +OpenSCAD files -------------- -The generator script `generate_scad.py` creates multiple files. +The generator script will create multiple files. -| File | Material | Description | -| --------------------- | -------- | --------------------------------------------------- | -| mkbd65_keymat.scad | TPU | Keymat should be printed with a 3D printer | -| mkbd65_pcb.scad | - | Just a spacer for the 3D model fitting | -| mkbd65_top_plate.scad | Aluminum | Laser cut on a CNC | -| mkbd65_internals.scad | ABS/PLA | Inner structure should be printed with a 3D printer | -| mkbd65.scad | - | Combination of the above files | +| File | Material | Description | +| ---------------------- | -------- | -------------------------------------- | +| mkbd65_key_mat.scad | TPU | 3D printable | +| mkbd65_pcb.scad | - | Just a spacer for the 3D model fitting | +| mkbd65_top_plate.scad | Acrylic | Laser cut on a CNC | +| mkbd65_lower_case.scad | PLA | 3D printable | +| mkbd65_internals.scad | PLA | 3D printable | +| mkbd65.scad | - | Combination of the above files | +--- + +![CC BY-SA 4.0](https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-sa.svg) +

mkbd65 case by XenGi is licensed under CC BY-SA 4.0

diff --git a/generate_scad.py b/generate_scad.py deleted file mode 100755 index 6057e47..0000000 --- a/generate_scad.py +++ /dev/null @@ -1,322 +0,0 @@ -#!/usr/bin/env python3 - -""" -mkbd65 openscad generator - -Usage: - python3 generate_scad.py [] - -Options: - -h --help Show this screen. - -Example: - python3 generate_scad.py oneplus5t.ini en_us-intl -""" - -import sys -from configparser import ConfigParser -from importlib import import_module - -from solid import cube, text, union, difference, linear_extrude, scad_render_to_file, OpenSCADObject, translate, color, \ - polygon, circle -from solid.utils import BlackPaint, White, Green, Aluminum, Cyan - - -def roundrect(width, height, radius): - """ - O/-----\O - / \ - | | - \ / - O\_____/O - - :param width: - :param height: - :param radius: - :return: - """ - return union()( - polygon([ - [0, radius], - [0, height - radius], - [radius, height], - [width - radius, height], - [width, height - radius], - [width, radius], - [width - radius, 0], - [radius, 0] - ]), - translate([radius, radius, 0])( - circle(r=radius) - ), - translate([radius, height - radius, 0])( - circle(r=radius) - ), - translate([width - radius, height - radius, 0])( - circle(r=radius) - ), - translate([width - radius, radius, 0])( - circle(r=radius) - ) - ) - - -def key(dx: int, dy: int, label_ltop: str = '', label_lbottom: str = '', label_rtop: str = '', label_rbottom: str = '', - label_center: str = '') -> OpenSCADObject: - """ - Generates a single key - - :param dx: width in mm - :param dy: length in mm - :param label: List of labels (top, bottom, right, middle) - :return: - """ - def get_size(s: str) -> float: - if s in ['⇧', '⏎']: - return 5 - elif s == '⌫': - return 3.5 - elif s in ['Esc', 'Ctrl', 'Alt', 'Fn']: - return 3 - else: - return 4 - - thickness = config.getfloat('key', 'thickness', fallback=1) - font = config.get('key', 'font', fallback='DejaVu Sans:style=Bold') - - return difference()( - linear_extrude(height=thickness)( - roundrect(width=dx, height=dy, radius=0.5) - ), - - translate(v=[1, 5.5, 0.8])( - linear_extrude(height=0.2)( - text(text=label_ltop, size=3, font=font, halign='left', valign='top') - ) - ), - translate(v=[1, 0.5, 0.8])( - linear_extrude(height=0.2)( - text(text=label_lbottom, size=3, font=font, halign='left', valign='bottom') - ) - ), - translate(v=[8.5, 5.5, 0.8])( - linear_extrude(height=0.2)( - text(text=label_rtop, size=3, font=font, halign='right', valign='top') - ) - ), - translate(v=[8.5, -1.5 if label_rbottom == '`' else 0.5, 0.8])( - linear_extrude(height=0.2)( - text(text=label_rbottom, size=3, font=font, halign='right', valign='bottom') - ) - ), - translate(v=[4.5, 3, 0.8])( - linear_extrude(height=0.2)( - text(text=label_center, size=get_size(label_center), font=font, halign='center', valign='center') - ) - ) - ) - - -def keymat() -> OpenSCADObject: - """ - Generates keymat - - mat: - +---------------------------------------------+ - | margin | - | +-----+ +-----+ +-----+ | - |margin| |padding| | ... | |margin| - | +-----+ +-----+ +-----+ | - | padding | - | +-----+ +-----+ +-----+ | - | | | | | | | | - | +-----+ +-----+ +-----+ | - | ... | - | +-----+ +-----+ +-----+ | - | | | | | | | | - | +-----+ +-----+ +-----+ | - | margin | - +---------------------------------------------+ - \ thickness - key: - +-----+ - | | dy - +-----+ - dx \ thickness - - :return: - """ - thickness = config.getfloat('keymat', 'thickness', fallback=0.5) - cols = 12 - rows = 5 - key_dx = 9 - key_dy = 6 - padding = 1 - margin = 2 - spacebar_x = 5 # nth key from the left - spacebar_length = 2 # length in keys - - keys = [] - for row in range(rows): - for col in range(cols): - keys.append( - translate([ - col * padding + col * key_dx + margin, - row * padding + row * key_dy + margin, - thickness - ])( - key( - dx=key_dx, - dy=key_dy, - label_ltop=layout[row][col][0], - label_lbottom=layout[row][col][1], - label_rtop=layout[row][col][2], - label_rbottom=layout[row][col][3], - label_center=layout[row][col][4] - ) - ) - ) - - return color(BlackPaint)( - union()( - # mat - cube([ - cols * key_dx + (cols - 1) * padding + 2 * margin, - rows * key_dy + (rows - 1) * padding + 2 * margin, - thickness - ]), - # keys - *keys, - # spacebar - translate([spacebar_x * key_dx + spacebar_x * padding + margin, margin, thickness])( - key(dx=key_dx * spacebar_length + (spacebar_length - 1) * padding, dy=key_dy) - ) - ) - ) - - -def pcb() -> OpenSCADObject: - rows = 5 - columns = 12 - hspacing = 4 - vspacing = 3 - width = 6 - height = 4 - thickness = 0.78 - switches = [] - - for row in range(rows): - for col in range(columns): - switches.append( - translate([3.5 + (hspacing + width) * col, 2 + (vspacing + height) * row, 0.6])( - color(White)( - linear_extrude(height=thickness)( - # 6 +----+ 5 - # / \ - # 7 + + 4 | 2mm - # 8 + + 3 | - # \ 4mm / - # 1 +----+ 2 - polygon(points=[(1, 0), (5, 0), (6, 1), (6, 3), (5, 4), (1, 4), (0, 3), (0, 1)]), - ) - ) - ) - ) - - return union()( - color(Green)(cube([123, 49, 0.6])), - # ATMEGA32U4 - translate([13, 36, 0.6])( - color(BlackPaint)(cube([7, 7, 1])) - ), - # Crystal - translate([23, 35.75, 0.6])( - color(BlackPaint)(cube([2.5, 2, 0.55])) - ), - *switches - ) - - -def top_plate() -> OpenSCADObject: - thickness = config.getfloat('keymat', 'thickness', fallback=1) - w = config.getfloat('phone', 'width') - h = config.getfloat('phone', 'height') - r = config.getfloat('phone', 'cornerradius') - - return color(Aluminum)( - difference()( - #cube([123, 49, 0.5]), - linear_extrude(height=thickness)( - roundrect(width=w, height=h, radius=r) - ), - translate([0, 0, -1 * thickness])(keymat()) - ) - ) - - -def internals() -> OpenSCADObject: - return color(Cyan)(cube([1, 1, 1])) - - -def mkbd65() -> OpenSCADObject: - fr4 = 0.4 # pcb thickness - switch = 0.78 # switch height - keymat_thickness = config.getfloat('keymat', 'thickness', fallback=1) - - return union()( - internals(), - pcb(), - color(BlackPaint)(translate([0, -1, fr4 + switch])(keymat())), - color(Aluminum)(translate([0, -1, fr4 + switch + keymat_thickness])(top_plate())) - ) - - -if __name__ == '__main__': - config = ConfigParser() - - if '-h' in sys.argv or '--help' in sys.argv or 2 > len(sys.argv) > 3: - sys.exit(__doc__) - - if len(sys.argv) == 3: - layoutfile = sys.argv[2] - else: - layoutfile = 'en_us-intl' - - try: - with open(sys.argv[1]) as fd: - config.read_file(fd) - layout = import_module(f'layout_{ layoutfile }').LAYOUT - file_header = '$fn = 16;' - scad_render_to_file( - keymat(), - filepath='./mkbd65_keymat.scad', - file_header=file_header, - ) - # TODO: generate mkbd65_pcb.scad - scad_render_to_file( - pcb(), - filepath='./mkbd65_pcb.scad', - file_header=file_header, - ) - # TODO: generate mkbd65_top_plate.scad - scad_render_to_file( - top_plate(), - filepath='./mkbd65_top_plate.scad', - file_header=file_header, - ) - # TODO: generate mkbd65_internals.scad - scad_render_to_file( - internals(), - filepath='./mkbd65_internals.scad', - file_header=file_header, - ) - # TODO: generate mkbd65.scad - scad_render_to_file( - mkbd65(), - filepath='./mkbd65.scad', - file_header=file_header, - ) - except FileNotFoundError: - sys.exit(f'The config file { sys.argv[1] } could not be found.') - except ModuleNotFoundError: - sys.exit(f'The layout file `layout_{ layoutfile }.py` could not be found.') diff --git a/layout_en_us-intl.py b/layout_en_us-intl.py deleted file mode 100644 index 56b120e..0000000 --- a/layout_en_us-intl.py +++ /dev/null @@ -1,81 +0,0 @@ -# [TopLeft, BottomLeft, TopRight, BottomRight, Middle] - -LAYOUT = [ - # row 4 - [ - ['', '', '', '', 'Ctrl'], # Left Control - ['', '', '', '', 'Fn'], # Function - ['', '', '', '', '⇧'], # Left Shift - ['', '', '', '', 'Alt'], # Left Alt (Alt Gr) - ['', '\\\\', '|', '', ''], - ['', '', '', '', ''], # Spacebar (won't be visible) - ['', '', '', '', ''], # Spacebar (won't be visible) - ['', '-', '_', '', ''], - ['', '=', '+', '', ''], - ['', '', '', '', '◀'], # Arrow Left / Home - ['', '', '', '', '▼'], # Arrow Down / Page Down - ['', '', '', '', '▶'] # Arrow Right / End - ], - # row 3 - [ - ['', '', '', '', 'Z'], - ['', '', '', '', 'X'], - ['', '', '', '', 'C'], - ['', '', '', '', 'V'], - ['', '', '', '', 'B'], - ['', '', '', '', 'N'], - ['', '', '', '', 'M'], - ['', ',', '<', '', ''], - ['', '.', '>', '', ''], - ['', '/', '?', '', ''], - ['', '', '', '', '▲'], # Arrow Up / Page Up - ['', '', '', '', '⇧'] # Right Shift - ], - # row 2 - [ - ['', '', '', '', 'A'], - ['', '', '', '', 'S'], - ['', '', '', '', 'D'], - ['', '', '', '', 'F'], - ['', '', '', '', 'G'], - ['', '', '', '', 'H'], - ['', '', '', '', 'J'], - ['', '', '', '', 'K'], - ['', '', '', '', 'L'], - ['', ';', ':', '', ''], - #['', '\'', '\\"', '`', ''], - ['', '\'', '\\"', '`', ''], - ['', '', '', '', '⏎'] # Return - ], - # row 1 - [ - ['', '', '', '', 'Q'], - ['', '', '', '', 'W'], - ['', '', '', '', 'E'], - ['', '', '', '', 'R'], - ['', '', '', '', 'T'], - ['', '', '', '', 'Y'], - ['', '', '', '', 'U'], - ['', '', '', '', 'I'], - ['', '', '', '', 'O'], - ['', '', '', '', 'P'], - ['', '[', '{', '', ''], - ['', ']', '}', '', ''] - ], - # row 0 - [ - ['','','','','Esc'], - ['', '1', '!', '', ''], - ['', '2', '@', '', ''], - ['', '3', '#', '', ''], - ['', '4', '$', '', ''], - #['', '5', '%', '€', ''], - ['', '5', '%', '', ''], - ['', '6', '^', '', ''], - ['', '7', '&', '', ''], - ['', '8', '*', '', ''], - ['', '9', '(', '', ''], - ['', '0', ')', '', ''], - ['', '', '', '', '⌫'] # Backspace - ] -] diff --git a/oneplus5t.ini b/oneplus5t.ini deleted file mode 100644 index a6d9927..0000000 --- a/oneplus5t.ini +++ /dev/null @@ -1,14 +0,0 @@ -; mkbd65 config for OnePlus 5t - -[keymat] -thickness = 0.5 -layout = en_us-intl - -[key] -thickness = 1 -font = DejaVu Sans:style=Bold - -[phone] -width = 156 -height = 75 -cornerradius = 10 \ No newline at end of file