Skip to content

Commit

Permalink
Whitespace changes
Browse files Browse the repository at this point in the history
  • Loading branch information
E4ST2W3ST committed Jan 1, 2024
1 parent 4b67c19 commit 3fa96e6
Show file tree
Hide file tree
Showing 11 changed files with 565 additions and 321 deletions.
2 changes: 1 addition & 1 deletion config/printer-elegoo-neptune3-pro-2023.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# "32KiB bootloader" and serial (on USART1 PA10/PA9) communication.

# For screen support, enable "Enable extra low-level configuration options"
# and select "Enable serial bridge" and then "USART6" then uncommit the [neptune_screen]
# and select "Enable serial bridge" and then "USART6" then uncommit the [neptune_screen]
# and serial_bridge sections


Expand Down
18 changes: 9 additions & 9 deletions docs/Config_Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4303,14 +4303,14 @@ information on menu attributes available during template rendering.

### [neptune screen]
Support for the Elegoo screen for the Neptune 3/3 Plus/3 Max.
A [serial bridge](#serial_bridge) must be setup for communciation to
A [serial bridge](#serial_bridge) must be setup for communciation to
take place. Communication is based on versions (1.4.2) and earlier.

```
[neptune_screen]
#serial_bridge:
# Name of the serial_bridge to be used for communication
#variant:
#variant:
# The device variant to report to the screen. Possible values are
# 3Pro: Neptune 3 Pro
# 3Max: Neptune 3 Max
Expand Down Expand Up @@ -4755,31 +4755,31 @@ via the `i2c_speed` parameter. All other Klipper micro-controllers use a
```

### [serial_bridge]
Communication between the mcu and devices connected to its UART ports
Communication between the mcu and devices connected to its UART ports
such as third-party screens can be bridged with this module. This feature
must be enabled with the low-level configuration options when compiling the
firmware specifying which ports should be available for the bridge to use.
firmware specifying which ports should be available for the bridge to use.
Currently only STM32 devices are supported.

See the [command reference](G-Codes.md#serial_bridge) for the different
See the [command reference](G-Codes.md#serial_bridge) for the different
options and configurations available.

```
[serial_bridge bridge_screen]
#eol:
# The character or string of characters to be sent at the end of each
# The character or string of characters to be sent at the end of each
# call. Defaults to \n
#baud
# The baud rate for communication. Default is 115200
#config:
# The serial configuration to use. These define the port and pins.
# The serial configuration to use. These define the port and pins.
# List them using the [command reference](G-Codes.md#serial_bridge)
# SERIAL_BRIDGE_LIST_CONFIGS
#tx_pin:
# Pin used for Tx. This is used to reserve the pin and to look up
# Pin used for Tx. This is used to reserve the pin and to look up
# the appropriate MCU
#rx_pin
# Pin used for Rx. This is used to reserve the pin and to look up
# Pin used for Rx. This is used to reserve the pin and to look up
# the appropriate MCU
#logging
# Boolean to turn logging of or on for debugging communication
Expand Down
4 changes: 2 additions & 2 deletions docs/G-Codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -1109,12 +1109,12 @@ has been enabled.
send a serial message (TEXT) to the bridge specificed (BRIDGE).

#### SERIAL_BRIDGE_LIST_CONFIGS
`SERIAL_BRIDGE_LIST_CONFIGS`: This command will list the available
`SERIAL_BRIDGE_LIST_CONFIGS`: This command will list the available
configurations reported by the MCU for use. This config should be used
when setting up a new [serial_bridge](Config_Reference.md#serial_bridge).

#### SERIAL_BRIDGE_LIST_BRIDGES
`SERIAL_BRIDGE_LIST_BRIDGES`: This command will list the available
`SERIAL_BRIDGE_LIST_BRIDGES`: This command will list the available
bridges ready for use from the printer configuration
[serial_bridge](Config_Reference.md#serial_bridge).

Expand Down
Loading

0 comments on commit 3fa96e6

Please sign in to comment.