Mercurial > louis > kiibohd-controller

changeset 160:68441d606782

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adding updated information on Windows Builds. - Windows builds and loading has been working just fine - screen does work with Cygwin, but there are output problems (echoing isn't working for basic input, commands still work) - TeraTerm works good, but kills the serial port if you don't quit after reloading the firmware
author Jacob Alexander <haata@kiibohd.com>
date Mon, 26 May 2014 22:46:03 -0700
parents 84beeecd2c94
children 38191c3242ca
files README
diffstat 1 files changed, 41 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/README	Sat Apr 26 01:29:09 2014 -0700
+++ b/README	Mon May 26 22:46:03 2014 -0700
@@ -44,6 +44,7 @@
 - git (needed for some compilation info)
 - cmake
 - gcc-core
+- gcc-g++
 - libusb1.0
 - libusb1.0-devel
 
@@ -52,6 +53,9 @@
 Add the following line to your .bashrc, making sure the CMake path is correct:
   alias wincmake="PATH='/cygdrive/c/Program Files (x86)/CMake 2.8'/bin:\"${PATH}\" cmake"
 
+Install the PJRC Virtual Serial Port Driver:
+(http://pjrc.com/teensy/serial_install.exe)
+
 Next, install the compiler(s) you want.
 
 
@@ -77,6 +81,11 @@
 
 http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/editions/lite-edition/
 
+Look for "Download the EABI Release".
+Enter your info to get the download link.
+Select the most recent download.
+Then download the "IA32 Windows Installer".
+
 Use the installer and make sure you add the binaries to your path within the installer.
 
 
@@ -241,9 +250,16 @@
 Linux Loading Firmware
 ----------------------
 
+First place the keyboard into re-flash mode.
+This can be done either by pressing the re-flash button on the PCB/Teensy.
+Or by entering the Kiibohd Virtual Serial Port and using the 'reload' command.
+
 The 'load' script that is created during the build can load the firmware over USB.
-It uses sudo, so make sure you have the priviledges.
+Either run it with sudo, or install the 98-kiibohd.rules to /etc/udev/rules.d
+ and run: udevadm control --reload-rules
 
+
+To load the newly built firmware:
 ./load
 
 
@@ -312,7 +328,18 @@
 Windows Loading Firmware
 ----------------------
 
-TODO
+First place the keyboard into re-flash mode.
+This can be done either by pressing the re-flash button on the PCB/Teensy.
+Or by entering the Kiibohd Virtual Serial Interface and using the 'reload' command.
+
+The 'load' script that is created during the build can load the firmware over USB.
+
+To load the newly built firmware:
+./load
+
+Be patient the couple of times, Windows is slow at installing drivers...
+
+
 
 ----------------------
 Mac OS X Building
@@ -320,6 +347,8 @@
 
 TODO
 
+
+
 ----------------------
 Mac OS X Loading Firmware
 ----------------------
@@ -327,6 +356,7 @@
 TODO
 
 
+
 ----------------------
 Virtual Serial Port - CLI
 ----------------------
@@ -334,20 +364,27 @@
 Rather than use a special program that can interpret Raw HID, this controller exposes a USB Serial CDC endpoint.
 This allows for you to use a generic serial terminal to debug/control the keyboard firmware (e.g. Tera Term, minicom, screen)
 
+
  -------
 | Linux |
  -------
 
 I generally use screen.
+You will need sudo/root priviledges if you haven't installed the 98-kiibohd.rules file to /etc/udev/rules.d 
 
-sudo screen /dev/ttyACM0
+screen /dev/ttyACM0
+(Might be ACM1, ACM2, etc.)
 
 
  ---------
 | Windows |
  ---------
 
-TODO Probably COM1, but not exactly sure. Tera Term.
+Make sure the Teensy Virtual Serial Port driver is installed.
+If possible use screen (as part of Cygwin).
+
+screen /dev/ttyS3
+(Might be a different file, ttyS0, ttyACM0, ttyUSB0, etc.)
 
 
  ----------