flexi-bot/docs/marlin/_setting/hardware.md
2023-09-05 20:38:49 +02:00

2.7 KiB

label brief category tags pagetype settings
Hardware Machine electronics and main components.
wip
hardware
toc
name type since brief long tags example
MOTHERBOARD board 1.0.0 Motherboard of the machine. Set the motherboard ID using one of the `BOARD_...` constants defined in `boards.h`. This option provides Marlin with the pin definitions it needs to control the onboard components and connected peripherals.
hardware
value
BOARD_RAMPS_14_EFB
name type since brief long examples subopts
SERIAL_PORT int 1.0.0 Main serial port. The main serial port is used to communicate with the host. This is usually the serial port connected to USB.
value comment
0 Set the first serial port to UART0
value comment
-1 Set the first serial port to Native USB
name type long
BAUDRATE int Default baud rate for the main serial port. (USB ports always run at full speed.)
name type since disabled brief long subopts
SERIAL_PORT_2 int 2.0.0 true Secondary serial port The secondary serial port can be used to communicate with a host, serial controller, or WiFi interface.
name type disabled long
BAUDRATE_2 int true Default baud rate for the secondary serial port. If not specified then `BAUDRATE` is used.
name type since disabled brief long subopts
SERIAL_PORT_3 int 2.0.0 true Secondary serial port The secondary serial port can be used to communicate with a host, serial controller, or WiFi interface.
name type disabled long
BAUDRATE_3 int true Default baud rate for the third serial port. If not specified then `BAUDRATE` is used.
name since disabled brief long
BLUETOOTH 1.1.0 true Bluetooth wireless interface. Enable the Bluetooth serial interface on AT90USB devices.
name type since disabled default brief long example
CUSTOM_MACHINE_NAME string 1.1.0 true "3D Printer" A unique name for your machine. Enable this option and set a unique name such as "Ralph" or "Printy McPrintface" to identify your 3D printer.
value
"X5 Endeavour"
name type since disabled default brief long example
MACHINE_UUID string 1.1.0 true "00000000-0000-0000-0000-000000000000" A unique ID for your machine. This unique ID can be used by some programs to differentiate between machines.
value
"A34F2190-C84E-F553-97C3-12A4DA78A01B"

Use these options to define the machine hardware, including the mainboard, serial ports, etc. These are the most basic settings for every type of machine that Marlin supports.