Skip to content

Commit

Permalink
Merge pull request #83 from MarioRicalde/ergodox-ez
Browse files Browse the repository at this point in the history
Ergodox EZ Banner Change
  • Loading branch information
robotmaxtron authored Jan 2, 2019
2 parents 5f44b59 + 897acd9 commit 9a52adb
Show file tree
Hide file tree
Showing 11 changed files with 289 additions and 42 deletions.
2 changes: 1 addition & 1 deletion deploy/css/main.css

Large diffs are not rendered by default.

Binary file added deploy/img/ergodox-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
78 changes: 41 additions & 37 deletions deploy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
<link rel="stylesheet" href="css/main.css">
<link href="https://overpass-30e2.kxcdn.com/overpass-mono.css" rel="stylesheet" />

<!-- Begin Jekyll SEO tag v2.2.3 -->
<!-- Begin Jekyll SEO tag v2.5.0 -->
<title>index | ErgoDox Mechanical Keyboard</title>
<meta name="generator" content="Jekyll v3.8.5" />
<meta property="og:title" content="index" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Documentation and build guide for the ErgoDox mechanical keyboard" />
Expand All @@ -18,7 +19,7 @@
<meta property="og:url" content="http://localhost:4000/" />
<meta property="og:site_name" content="ErgoDox Mechanical Keyboard" />
<script type="application/ld+json">
{"@context":"http://schema.org","@type":"WebSite","name":"ErgoDox Mechanical Keyboard","headline":"index","description":"Documentation and build guide for the ErgoDox mechanical keyboard","url":"http://localhost:4000/"}</script>
{"name":"ErgoDox Mechanical Keyboard","description":"Documentation and build guide for the ErgoDox mechanical keyboard","@type":"WebSite","url":"http://localhost:4000/","headline":"index","@context":"http://schema.org"}</script>
<!-- End Jekyll SEO tag -->

</head>
Expand Down Expand Up @@ -185,8 +186,6 @@
</li>

</ul>
<a href="http://ergodox-ez.com" id="ezbanner" target="_blank" title="ErgoDox EZ"><img src="../img/ergodox_ez.svg"></a>

</div>

<div class="content">
Expand Down Expand Up @@ -371,9 +370,8 @@ <h4>Case & Keycaps</h4>

<p>The 1.5u outer column keys can optionally be mounted closer in and 1u keycaps can be used.</p>

<div class="highlighter-rouge"><pre class="highlight"><code>Note: This layout is only supported on the newer (post 2012) revisions of the pcb and will require a modified plate design to support the new placement.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: This layout is only supported on the newer (post 2012) revisions of the pcb and will require a modified plate design to support the new placement.
</code></pre></div></div>

<ul>
<li>If the 80 key layout is used, a slightly different keycap configuration will be needed replacing the 2u keys with two 1u keys each:
Expand Down Expand Up @@ -403,24 +401,21 @@ <h2>Assembly Guide</h2>
<li><img src="../img/diode-min.jpg" alt="diode" /></li>
<li>1b. If <em>through hole</em> diodes are chosen, place them through the two hole immediately to the left and right of copper pads under the square that the switch will take up. Be sure to check the orientation to be sure that the cathode/negative side of the diode is closest to the square hole. Solder and repeat for each switch on both hands.</li>
<li><img src="../img/th-diode-min.jpg" alt="Through-hole diode" />
<div class="highlighter-rouge"><pre class="highlight"><code> Note: The additional holes in this second image are for through switch LEDs. Only one diode per switch is needed.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> Note: The additional holes in this second image are for through switch LEDs. Only one diode per switch is needed.
</code></pre></div> </div>
</li>
</ul>
</li>
<li>
<p>Flip both of the pcbs over, this face up side (without the diodes) will be the side that the remaining components will be placed.</p>
</li>
<li>Insert both the 2.2k ohm resistors and 220 ohm (or whatever resistors chosen appropriate for the leds selected) onto the right hand where labled on the pcb and solder into place.
<div class="highlighter-rouge"><pre class="highlight"><code>Note: Keep the legs clipped off the resistors, they can be used in a later step when the TRRS connections are installed.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: Keep the legs clipped off the resistors, they can be used in a later step when the TRRS connections are installed.
</code></pre></div> </div>
</li>
<li>On the left hand pcb, insert the I/O expander around the MCP23018 rectangle. The I/O expander is directional and the notch on the I/O expander should match up with the silkscreen. The notch on the expander will be facing ErgoDox printing on the circuit board. See the image in the next step for an example.
<div class="highlighter-rouge"><pre class="highlight"><code>Note: There are three holes without copper pads and do not need to be soldered.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: There are three holes without copper pads and do not need to be soldered.
</code></pre></div> </div>
</li>
<li><em>(Optional but suggested step)</em> On the left hand pcb, insert the ceramic capacitor into the first and third holes of the top row and solder in place.
<ul>
Expand All @@ -436,9 +431,8 @@ <h2>Assembly Guide</h2>
</ul>
</li>
<li>Install the male jumper pins to the underside of the Teensy with the button face up and solder the pins to the top side of the Teensy.
<div class="highlighter-rouge"><pre class="highlight"><code>Note: If the Teensy already has jumpers already installed, skip this step.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: If the Teensy already has jumpers already installed, skip this step.
</code></pre></div> </div>
</li>
<li>Insert the Teensy jumper legs from the Teensy assembly onto the right hand pcb with the usb facing the direction of the resistors and solder in place.
<ul>
Expand All @@ -449,12 +443,11 @@ <h2>Assembly Guide</h2>
<ul>
<li>9a. Strip off all of the sheathing from the cable, exposing the 4 wires.</li>
<li>9b. Place the following wires into their respective holes:
<div class="highlighter-rouge"><pre class="highlight"><code>White: D-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>White: D-
Red: 5v
Green: D+
Black: GND
</code></pre>
</div>
</code></pre></div> </div>
</li>
<li>9c. Solder wires to the pcb.</li>
<li><img src="../img/wiring-min.jpg" alt="wiring" /></li>
Expand All @@ -478,16 +471,14 @@ <h2>Assembly Guide</h2>
</ul>
</li>
<li>11c. Solder switches in place.
<div class="highlighter-rouge"><pre class="highlight"><code>Note: Make note of the location for the three switches on the right hand that will support the LEDs
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: Make note of the location for the three switches on the right hand that will support the LEDs
</code></pre></div> </div>
</li>
</ul>
</li>
<li>On the right hand, insert the three leds through the housing of the three switches and solder into place.
<div class="highlighter-rouge"><pre class="highlight"><code>Note: LEDs have polarity so be sure that the negative leg (which is the shorter of the two legs) of the LEDs goes into the (face up) square hole.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: LEDs have polarity so be sure that the negative leg (which is the shorter of the two legs) of the LEDs goes into the (face up) square hole.
</code></pre></div> </div>
</li>
<li>Finish assembling the case, plug in the TRRS cable between the two halves and proceed to building and flashing the selected firmware.</li>
</ol>
Expand Down Expand Up @@ -532,9 +523,8 @@ <h4>QMK</h4>

<p>A build guide for compiling and customizing your firmware is best found in the repo’s <a href="https://github.com/jackhumbert/qmk_firmware">readme</a></p>

<div class="highlighter-rouge"><pre class="highlight"><code>Note: There are many users who have committed their keymaps that can be built on and easily adapted to suit your needs.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: There are many users who have committed their keymaps that can be built on and easily adapted to suit your needs.
</code></pre></div></div>

<p>The ErgoDox-EZ Configurator tool can also be used to generate keymappings and their .hex files with QMK.</p>

Expand Down Expand Up @@ -622,9 +612,8 @@ <h3>Flashing your Ergodox</h3>
<li>Start the Teensy Loader program</li>
<li>Load the .hex file into it.</li>
<li>Press the Reset button by pressing the reset button onboard the Teensy, you may need to insert something such as a paperclip or small screwdriver gently into the reset hole in the top right corner of your case.
<div class="highlighter-rouge"><pre class="highlight"><code>Note: Some firmware (such as QMK and TMK) allow for the resetting of your atmel chip to be programmed as a keycode.
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>Note: Some firmware (such as QMK and TMK) allow for the resetting of your atmel chip to be programmed as a keycode.
</code></pre></div> </div>
</li>
<li>Click the button in the Teensy app to upload the firmware to your keyboard.</li>
</ol>
Expand Down Expand Up @@ -793,9 +782,8 @@ <h2>Gamepad</h2>
<p><img src="../img/gamepad2-min.jpg" alt="Gamepad" /></p>

<p>The new “top” of PCB. Teensy is installed upside down. 2.2k resistors, jumpers, and USB port installed on top. In this revision of the PCB, the jumpers dictate which side the USB port can be installed on as well as the TRRS port (which isn’t used in gamepad configuration).</p>
<div class="highlighter-rouge"><pre class="highlight"><code> Note: that the USB connection wires are installed (from left to right) empty, black, green, red, white. This is different from the silk screen layout as the usb port is now on "backwards".
</code></pre>
</div>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> Note: that the USB connection wires are installed (from left to right) empty, black, green, red, white. This is different from the silk screen layout as the usb port is now on "backwards".
</code></pre></div></div>
<p><img src="../img/gamepad4-min.jpg" alt="Gamepad" /></p>

<p>The new “bottom” of the PCB. The reset switch has been soldered to the bottom. LED resistors have also been soldered to bottom.</p>
Expand All @@ -806,6 +794,22 @@ <h2>Gamepad</h2>


</div>

<section class="fixed-banner" id="fixedBanner">
<span class="close">X</span>
<span class="detail">SPONSORED BY</span>
<div class="wrapper">
<div class="display">
<img src="../img/ergodox-logo.png" alt="" width="429" height="65" title="ErgoDox EZ">
</div>
<span class="decoration"></span>
<div class="column">
<div class="title">Pre-assembled, improved, with a 2-year warranty.</div>
<a href="https://ergodox-ez.com/?source=ergodox-io" class="link" title="Customize yours today">Customize yours today</a>
</div>
</div>
</section>

</div>

<script src="js/jquery-2.1.1.min.js"></script>
Expand Down
40 changes: 39 additions & 1 deletion deploy/js/scripts.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,46 @@ $(document).ready(function(){
$('#nav').onePageNav();

$('a[href^="http"]').attr('target','_blank');

$('.toggle').click(function(){
$('.overview').toggleClass('open');
});

fixedBanner()
});

function fixedBanner() {
var $banner = $('#fixedBanner'),
cookieName = 'hideBanner'

if (getCookie(cookieName) !== 'true') {
$banner.addClass('show')
}

$banner.find('.close').click(function() {
$banner.removeClass('show')
setCookie(cookieName, true, 30)
})
}
function setCookie(cname, cvalue, exdays) {
var d = new Date();
d.setTime(d.getTime() + (exdays*24*60*60*1000));
var expires = "expires="+ d.toUTCString();
document.cookie = cname + "=" + cvalue + ";" + expires + ";path=/";
}

function getCookie(cname) {
var name = cname + "=";
var decodedCookie = decodeURIComponent(document.cookie);
var ca = decodedCookie.split(';');
for(var i = 0; i <ca.length; i++) {
var c = ca[i];
while (c.charAt(0) == ' ') {
c = c.substring(1);
}
if (c.indexOf(name) == 0) {
return c.substring(name.length, c.length);
}
}
return "";
}
14 changes: 14 additions & 0 deletions src/_includes/fixed-banner.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<section class="fixed-banner" id="fixedBanner">
<span class="close">X</span>
<span class="detail">SPONSORED BY</span>
<div class="wrapper">
<div class="display">
<img src="../img/ergodox-logo.png" alt="" width="429" height="65" title="ErgoDox EZ">
</div>
<span class="decoration"></span>
<div class="column">
<div class="title">Pre-assembled, improved, with a 2-year warranty.</div>
<a href="https://ergodox-ez.com/?source=ergodox-io" class="link" title="Customize yours today">Customize yours today</a>
</div>
</div>
</section>
3 changes: 1 addition & 2 deletions src/_includes/nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,4 @@
{% endif %}
</li>
{% endfor %}
</ul>
<a href="http://ergodox-ez.com" id="ezbanner" target="_blank" title="ErgoDox EZ"><img src="../img/ergodox_ez.svg"></a>
</ul>
2 changes: 2 additions & 0 deletions src/_layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
<span class="toggle">open</span>
{{ content }}
</div>

{% include fixed-banner.html %}
</div>

<script src="js/jquery-2.1.1.min.js"></script>
Expand Down
1 change: 1 addition & 0 deletions src/_sass/modules/_all.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
@import "typography";
@import "functions";
@import "mixins";
@import "partials/fixed-banner";
Loading

0 comments on commit 9a52adb

Please sign in to comment.