Skip to content

Commit

Permalink
Updates to README and make it V1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@andrewfernie
andrewfernie committed Nov 14, 2021
1 parent 11596cb commit 790f68d
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 21 deletions.
32 changes: 16 additions & 16 deletions GRBLPendant/.vscode/c_cpp_properties.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@
{
"name": "PlatformIO",
"includePath": [
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/include",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/src",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/include",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Encoder",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Encoder/utility",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/EEPROM",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/lib/USBHost_t36",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/lib/USBHost_t36/utility",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/ArduinoMenu library/src",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/lib/USBHost_t36",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/lib/USBHost_t36/utility",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/ArduinoMenu library/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Keypad/src",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/ClickEncoder",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/LiquidCrystal",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/ClickEncoder",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/LiquidCrystal",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Wire",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Wire/utility",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/Bounce2/src",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/Bounce2/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/cores/teensy4",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/SD/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/SPI",
Expand Down Expand Up @@ -122,20 +122,20 @@
"browse": {
"limitSymbolsToIncludedHeaders": true,
"path": [
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/include",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/src",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/include",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Encoder",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Encoder/utility",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/EEPROM",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/lib/USBHost_t36",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/lib/USBHost_t36/utility",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/ArduinoMenu library/src",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/lib/USBHost_t36",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/lib/USBHost_t36/utility",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/ArduinoMenu library/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Keypad/src",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/ClickEncoder",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/LiquidCrystal",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/ClickEncoder",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/LiquidCrystal",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Wire",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/Wire/utility",
"C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/libdeps/teensy41/Bounce2/src",
"C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/libdeps/teensy41/Bounce2/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/cores/teensy4",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/SD/src",
"C:/Users/andre/.platformio/packages/framework-arduinoteensy/libraries/SPI",
Expand Down
6 changes: 3 additions & 3 deletions GRBLPendant/.vscode/launch.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"type": "platformio-debug",
"request": "launch",
"name": "PIO Debug",
"executable": "C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/build/teensy41/firmware.elf",
"executable": "C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/build/teensy41/firmware.elf",
"projectEnvName": "teensy41",
"toolchainBinDir": "C:/Users/andre/.platformio/packages/toolchain-gccarmnoneeabi/bin",
"internalConsoleOptions": "openOnSessionStart",
Expand All @@ -25,7 +25,7 @@
"type": "platformio-debug",
"request": "launch",
"name": "PIO Debug (skip Pre-Debug)",
"executable": "C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/build/teensy41/firmware.elf",
"executable": "C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/build/teensy41/firmware.elf",
"projectEnvName": "teensy41",
"toolchainBinDir": "C:/Users/andre/.platformio/packages/toolchain-gccarmnoneeabi/bin",
"internalConsoleOptions": "openOnSessionStart"
Expand All @@ -34,7 +34,7 @@
"type": "platformio-debug",
"request": "launch",
"name": "PIO Debug (without uploading)",
"executable": "C:/Users/andre/Repositories/PlatformIO/GRBLPendant/.pio/build/teensy41/firmware.elf",
"executable": "C:/Users/andre/Repositories/CNCControl/GRBLPendant/.pio/build/teensy41/firmware.elf",
"projectEnvName": "teensy41",
"toolchainBinDir": "C:/Users/andre/.platformio/packages/toolchain-gccarmnoneeabi/bin",
"internalConsoleOptions": "openOnSessionStart",
Expand Down
2 changes: 1 addition & 1 deletion GRBLPendant/src/GRBLPendant.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
// Defines
// ===============================================
//
constexpr auto ProgramVersion = 0.31;
constexpr auto ProgramVersion = "1.0.0";

//
// ===============================================
Expand Down
Binary file added Images/ControlsAndDisplays.pdn
View file
Binary file not shown.
Binary file added Images/ControlsAndDisplays.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 8 additions & 1 deletion README.MD
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# GRBL Pendant

## Introduction
This project is a pendant for a GRBL CNC controller. It can act standalone, requiring connections only to the GRBL controller and to power, or can sit between a PC running a gcode sender application such as UGS and the GRBL controller.

![GRBLPendant](Images/TopView.png)
Expand All @@ -16,6 +17,7 @@ This version runs on a Teensy 4.1 which allows it to act as a USB host to drive

![Rear Panel](Images/RearView.png)

## Components Used
It uses standard hardware available from all the usual sources. The main components are:
1. Teensy 4.1 https://www.pjrc.com/store/teensy41.html
2. Qty 2 20x4 LCD displays using I2C connections (set to addressed 0x26 and 0x27) like this https://www.amazon.com/GeeekPi-Interface-Adapter-Backlight-Raspberry/dp/B086VVT4NH
Expand All @@ -26,5 +28,10 @@ It uses standard hardware available from all the usual sources. The main compone
7. 4x4 keypad https://www.amazon.ca/SunFounder-Matrix-Keypad-Arduino-Raspberry/dp/B015E32IXY


Twenty buttons in a 4x5 scanned matrix array are used for most control funtions. The 4x4 keypad to the right is a purchased array of microswitches to which I added 3D printed key caps and frame. The four in the left most row used for axis control and jog cancel were added later, and room was tight, so slightly smaller individual switches were used. The last four switches, as well as the one to the top left of the jog wheel, are 10mm x 10mm pushbuttons from my local electronics store. Starting over, a 4x5 array of identical switches would be nicer.
Twenty buttons in a 4x5 scanned matrix array are used for most control funtions. The 4x4 keypad to the right is a purchased array of microswitches to which I added 3D printed key caps and frame. The four in the left most row used for axis control and jog cancel were added later, and room was tight, so slightly smaller individual switches were used. The last four switches, as well as the one to the top left of the jog wheel, are 10mm x 10mm pushbuttons from my local electronics store. Starting over, a 4x5 array of identical switches would be nicer. STL files for the key caps and frames are provided in the Hardware folder.

Stickers were printed on "printable vinyl" sheets https://www.aliexpress.com/item/1005003231276942.html. Images for the stickers are provided in the Hardware folder.

## Controls and Displays

![Controls and Displays](Images/ControlsAndDisplays.png)

0 comments on commit 790f68d

Please sign in to comment.