Skip to content

Commit 88861ec

Browse files
fix typos (#226)
1 parent e085ce3 commit 88861ec

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

Klipper_Expander/Documentation/README.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ Welcome to your new Klipper Expander! This document outlines the common features
2727

2828
# Basic
2929

30-
First we will go through the basic functionality of the board that most users will be looking for
30+
First we will go through the basic functionality of the board that most users will be looking for.
3131

3232
## Indicator LEDs
3333

3434
There are 3 status indicator LEDs on the board:
35-
- 5v Status near the USB port indicates that there is 5V present and feeding the board (D6)
36-
- Board Ready near the IC indicates that the board is communicating with Klipper (D1)
37-
- Vin status indicates that there is power present on the Vin and GND feeding the board through the screw terminals (D7)
35+
- 5v Status near the USB port indicates that there is 5V present and feeding the board (`D6`)
36+
- Board Ready near the IC indicates that the board is communicating with Klipper (`D1`)
37+
- Vin status indicates that there is power present on the Vin and GND feeding the board through the screw terminals (`D7`)
3838
- 4 indicator LEDs (D2-D5) near each of the MOSFETs and screw terminals, these indicate if the MOSFET is enabled
3939

4040
<img src="../Images/LEDs.png" width="600">\
@@ -49,12 +49,12 @@ There is one switch, labeled RST. This resets the board
4949

5050
## I2C Header (PF0, PF1)
5151

52-
Contains a 3.3V I2C bus for connecting displays, and other sensors such as environemntal sensors and breakout expanders.
52+
Contains a 3.3V I2C bus for connecting displays, and other sensors such as enviromental sensors and breakout expanders.
5353
This plugs into J2
5454

5555
<img src="../Images/I2C.png" width="300">
5656

57-
Both SCL and SDA pins are pulled up to 3V3 with a 4.7k resistor
57+
Both `SCL` and `SDA` pins are pulled up to 3V3 with a 4.7k resistor
5858

5959
<img src="../Images/I2C_Schematic.png" width="300">
6060

@@ -76,7 +76,8 @@ Vin and GND are for feeding power to the Mosfets, this can be any voltage under
7676
The fuse is a micro blade type fuse and should be chosen to the maximum draw of all of the MOSFET fed devices.
7777

7878
For example, if you are running a 40W heater, 2 5W fans and 1 2W fan, you will need a total of 62W of power.
79-
At 24V, this would translate to 62W/24V = 2.58A. The closest fuse might be a 5A fuse, which you should use.
79+
At 24V, this would translate to 62W/24V = 2.58A. The closest fuse might be a 5A fuse, which is recommended you
80+
should use.
8081

8182
Maximum power should not exceed 12A as the MOSFETs are each rated to a maximum of 3A.
8283

@@ -85,7 +86,7 @@ Maximum power should not exceed 12A as the MOSFETs are each rated to a maximum o
8586

8687
## Mosfets (PA0, PA1, PA2, PA3)
8788

88-
4 x 4 3A Amp mosfets fopr controlling LED's, Heater, Fans, and other accessories
89+
4 x 4 3A Amp mosfets for controlling LED's, Heater, Fans, and other accessories
8990
Connected to pins PA0, PA1, PA2 and PA3
9091

9192
<img src="../Images/Mosfets.png" width="300">
@@ -102,7 +103,7 @@ _You may need to change `expander:` to match your expander mcu name_
102103

103104
## Thermistors (PA5, PA6)
104105

105-
2 thermsitor inputs that use a 4.7K pullup resistor (Klipper default)
106+
2 thermistor inputs that use a 4.7K pullup resistor (Klipper default)
106107
Connected to pins PA5 and PA6
107108

108109
<img src="../Images/Thermistors.png" width="300">
@@ -126,7 +127,7 @@ _You may need to change `expander:` to match your expander mcu name_
126127

127128
## Neopixel header (PB1)
128129

129-
Header for using neopixels. there is a single power input pin (NPV) that you can supply with the voltage your struip needs (5V/12V) and it passes it to the three pin header (Vin,Data,Ground)
130+
Header for using neopixels. There is a single power input pin (NPV) that you can supply with the voltage your strip needs (5V/12V) and it passes it to the three pin header (Vin, Data, Ground)
130131
Connected to J1, which has a NPV supplied voltage, GND and PB1
131132

132133
<img src="../Images/Neopixel.png" width="150"> <img src="../Images/KlipperExpander_NeopixelWiring.png" width="800">
@@ -150,7 +151,7 @@ Here are some more advanced features and details about the board
150151

151152
## Boot Jumper
152153

153-
This jumper needs to be installed to put the board in DFU mode to flash with klipper firmware. The board will show up as "Device in DFU Mode" to `lsusb` and then should show up in `dfu-util --list`
154+
This jumper needs to be installed to put the board in DFU mode to flash it with the klipper firmware. The board will show up as "Device in DFU Mode" to `lsusb` and then should show up in `dfu-util --list`
154155

155156
<img src="../Images/Boot.png" width="300">
156157

@@ -177,27 +178,25 @@ PA7 is connected directly to the STM32 with no pullups
177178
<img src="../Images/GPIO_Schematic.png" width="300">
178179

179180

180-
181-
182181
# Testing
183182

184183
Included configuration file [](../Software/standalone.cfg) will allow you to startup the Expander without another MCU to validate all features are functional.
185184

186185
You will need the following devices:
187186
- Power supply (5V is easiest)
188187
- 4 x devices for MOSFET that will work at Power supply voltage
189-
- Neopixel with appropriate dupont headere (WS2812b for 5V or WS2811 for 12V)
190-
- Display like this one: [Adafruit OLED Display](https://www.adafruit.com/product/931)
188+
- Neopixel with appropriate dupont headers (WS2812b for 5V or WS2811 for 12V)
189+
- Display (like this one: [Adafruit OLED Display](https://www.adafruit.com/product/931))
191190
- 2 Thermistors with dupont or JST headers
192191
- Raspberry Pi or another computer running Klipper
193192

194-
Use the [Example](../Software/standalone.cfg) confiugration supplied in this repository
193+
Use the [Example](../Software/standalone.cfg) configuration supplied in this repository
195194

196195
When the Expander starts up you should see:
197196
- All 3 Status LEDs light up
198197
- None of the MOSFETs light up
199198
- Neopixel will be orange
200-
- Display will have 3d printer typical display
199+
- Display will have a typical 3d printer interface
201200

202201
Other steps:
203202
- Run a M105 to get temperature readings
@@ -217,8 +216,8 @@ Sometimes problems happen, here is how you can fix them
217216

218217
## Why do I want this?
219218

220-
The Expander gives you extra connectivity that suppliments your main MCU(s) without the cost and size of a full board. Also you can use an Expander to run devices at a different voltage than the main MCU. i.e. Noctua fans are 12V where the main MCU is 24V
219+
The Expander gives you extra connectivity that suppliments your main MCU(s) without the cost and size of a full board. You can also use an Expander to run devices at a different voltage than the main MCU; i.e. Noctua fans are 12V where the main MCU is 24V
221220

222221
## How do I get one?
223222

224-
Included in this repository are [Production Files](../Production_Files) which you can use to order from [JLCPCB](https://jlcpcb.com) or anywhere else you order boards from. Alternatively, on the Voron Discord you may find someone selling one preassembled if you post in #flea-market
223+
Included in this repository are [Production Files](../Production_Files) which you can use to order from [JLCPCB](https://jlcpcb.com) or anywhere else you order boards from. Alternatively, on the Voron Discord you may find someone selling one preassembled boards if you post in `#flea-market`

0 commit comments

Comments
 (0)