(taken form figgyc's commit)

• SoC: MediaTek MT7688AN @ 580 MHz

• Flash: BoyaMicro BY25Q128AS (16 MiB, SPI NOR)

• RAM: 128 MiB DDR2 (Winbond W971GG6SB-25)

• Peripheral: Genesys Logic GL850G 2 port USB 2.0 hub

• I/O: 1x 10/100 Ethernet port, microSD SD-XC Class 10 slot, 4x LEDs, 2x USB 2.0 ports, micro USB input (for power only), reset button

• FCC ID: 2AXH6CREALITY-BOX

• UART: test pads: (square on silkscreen) 3V3, TX, RX, GND; default baudrate: 57600

• Only neccesary until the port gets merged and officially supported.

  • I recommend following figgyc's post. You'll find there his experience and a guide to compile OpenWrt. Here is his OpenWrt branch with support for the Creality Wi-Fi Box and the PR pending to merge to main OpenWrt.

  • ❗ This is an OpenWrt snapshot (aka not officially supported) and kernel modules can't be installed with opkg. You NEED to choose some required kmods inside make menuconfig:
    kmod-fs-ext4 kmod-usb-storage kmod-usb-ohci kmod-usb-uhci kmod-usb-serial kmod-usb-serial-ch341* kmod-video-core kmod-video-uvc
    *(chose this because my printer has the ch341 serial usb convertor. You might want to choose kmod-usb-serial-fttdi if your mainboard uses that - check this before building/compiling)

  OR use the provided image I built located inside Firmware/OpenWrt_snapshot - Be aware though that this was built with only the kmod-usb-serial-ch431 - if your mainboard is different -> use the above instructions to compile.

Flashing:

1. Rename factory.bin to cxsw_update.tar.bz2
2. Copy it to the root of a FAT32 formatted microSD card.
3. Turn on the device, wait for it to start, then insert the card. The stock firmware reads the install.sh script from this archive, the build script I added creates one that works in a similar way. Web firmware update didn't work in my testing.

• If the flashing was successful you should be able to ssh to the box through ethernet. Plug it in your PC (prefered way) or router and do ssh [email protected] in Windows PowerShell or any unix terminal or use putty.
• Edit /etc/config/network, /etc/config/wireless and /etc/config/firewall. I've uploaded these to follow as a model (inside Wi-Fi).
• Use iw dev wlan0 scan to scan for near wi-fi networks and look for the bssid specific to your 2.4Ghz SSID.

• Extroot

opkg update && opkg install block-mount kmod-fs-ext4 kmod-usb-storage kmod-usb-ohci kmod-usb-uhci e2fsprogs fdisk
DEVICE="$(sed -n -e "/\s\/overlay\s.*$/s///p" /etc/mtab)"
uci -q delete fstab.rwm
uci set fstab.rwm="mount"
uci set fstab.rwm.device="${DEVICE}"
uci set fstab.rwm.target="/rwm"
uci commit fstab

mkfs.ext4 /dev/mmcblk0p1

DEVICE="/dev/mmcblk0p1"
eval $(block info "${DEVICE}" | grep -o -e "UUID=\S*")
uci -q delete fstab.overlay
uci set fstab.overlay="mount"
uci set fstab.overlay.uuid="${UUID}"
uci set fstab.overlay.target="/overlay"
uci commit fstab
mount /dev/mmcblk0p1 /mnt
cp -f -a /overlay/. /mnt
umount /mnt
reboot

• swap (though the existing 128mb RAM seemed more than enough)

run this once:

opkg update && opkg install swap-utils

dd if=/dev/zero of=/overlay/swap.page bs=1M count=512
mkswap /overlay/swap.page 
swapon /overlay/swap.page
mount -o remount,size=200M /tmp 

put this inside /etc/rc.local above exit so that swap is enabled at boot:

###activate the swap file on the SD card  
swapon /overlay/swap.page  

###expand /tmp space  
mount -o remount,size=200M /tmp  

• for Klipper and moonraker - check the requirements folder.

• ❗ Python2 packages are not available by default for this snapshot A workaround I found was to use the v19.07 OpenWrt release feeds (this version still has python2 packages) for the same target (ramips/mt76x8) and cpu architecture (mipsel_24kc) as the box. I make a backup of the original /etc/opkg/distfeeds.conf and create another distfeeds.conffile with the v19.07 url feeds. Don't forget to run opkg update everytime you make modifications to that file. After finishing with installing the packages that are only available for the v19.07 and below (like python2 packages) I switch back to the backup distfeeds.conf file.

• The distfeeds.conf file with openwrt v19.07 feeds should look something like this:

src/gz openwrt_core http://downloads.openwrt.org/releases/19.07.7/targets/ramips/mt7621/packages   
src/gz openwrt_freifunk http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/freifunk  
src/gz openwrt_base http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/base  
src/gz openwrt_luci http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/luci  
src/gz openwrt_packages http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/packages  
src/gz openwrt_routing http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/routing  
src/gz openwrt_telephony http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/telephony  

• Do opkg update
  ❗ If you get wrong signature errors, comment the option check_signature line under /etc/opkg.conf - you can uncomment this after finishing with v19.07 distfeeds
• After you add the v19.07 distfeeds.conf -> install python2 packages:

opkg install python python-pip python-cffi python-pyserial python-dev gcc  

❗ The official pyserial python package is not configured to work with 250000 baud on MIPS platforms (only 230400 max). If you want/need 250k baud, install this version of pyserial and install it with python2 setup.py install

pip install greenlet==0.4.15 jinja2 python-can==3.3.4  

• Switch back to original distfeeds.conf, opkg update -> install python3 and packages:

opkg install python3 python3-pip python3-pyserial python3-pillow python3-tornado python3-distro --force-overwrite 

pip3 install inotify-simple

if you get errors with this check the instructions from requirements folder, you might have to manually update setuptools. After that the previous command will work

pip3 install python-jose libnacl  

lmdb and streaming-form-data can be found inside Packages as a single *ipk file. I cross-compiled those while building the OpenWrt image as I couldn't install it with pip (they need gcc>=8.4 which is not available for OpenWrt yet). To install a *ipk file do: opkg install filename_of_package.ipk.

• Install nginx with opkg install nginx-ssl libsodium

• 6.1 Clone Klipper inside ~/
  - do opkg install git-http unzip then git clone https://github.com/KevinOConnor/klipper.git.
• 6.2 Use provided klipper service and place inside /etc/init.d/
• 6.3 Enable klipper service: Everytime you create a service file you need to give it executable permissions first before enabling it. For klipper do chmod 755 klipper. You can enable it now by /etc/init.d/klipper enable
• 6.4 Prepare your printer.cfg file - do mkdir ~/klipper_config and mkdir ~/gcode_files . Locate your .cfg file inside ~/klipper/config/ copy it to ~/klipper_config and rename it to printer.cfg - Inside printer.cfg under [mcu] replace serial line with serial: /dev/ttyUSB0 and add a new line: baud: 230400 (check requirements if you want/need 250000 baud) - Add these lines at the end of the file:

[virtual_sdcard]
# for gcode upload
path: /root/gcode_files

[display_status]
# for display messages in status panel

[pause_resume]
# for pause/resume functionality. 
# Mainsail/fluidd needs gcode macros for `PAUSE`, `RESUME` and `CANCEL_PRINT` to make the buttons work.

[gcode_macro CANCEL_PRINT]
rename_existing: BASE_CANCEL_PRINT
gcode:
  TURN_OFF_HEATERS
  CLEAR_PAUSE
  SDCARD_RESET_FILE
  BASE_CANCEL_PRINT

[gcode_macro PAUSE]
rename_existing: BASE_PAUSE
# change this if you need more or less extrusion
variable_extrude: 1.0
gcode:
  ##### read E from pause macro #####
  {% set E = printer["gcode_macro PAUSE"].extrude|float %}
  ##### set park positon for x and y #####
  # default is your max posion from your printer.cfg
  {% set x_park = printer.toolhead.axis_maximum.x|float - 5.0 %}
  {% set y_park = printer.toolhead.axis_maximum.y|float - 5.0 %}
  ##### calculate save lift position #####
  {% set max_z = printer.toolhead.axis_maximum.z|float %}
  {% set act_z = printer.toolhead.position.z|float %}
  {% if act_z < (max_z - 2.0) %}
      {% set z_safe = 2.0 %}
  {% else %}
      {% set z_safe = max_z - act_z %}
  {% endif %}
  ##### end of definitions #####
  SAVE_GCODE_STATE NAME=PAUSE_state
  BASE_PAUSE
  G91
  G1 E-{E} F2100
  G1 Z{z_safe} F900
  G90
  G1 X{x_park} Y{y_park} F6000

[gcode_macro RESUME]
rename_existing: BASE_RESUME
gcode:
  ##### read E from pause macro #####
  {% set E = printer["gcode_macro PAUSE"].extrude|float %}
  ##### end of definitions #####
  G91
  G1 E{E} F2100
  RESTORE_GCODE_STATE NAME=PAUSE_state
  BASE_RESUME

• 6.5 Restart klipper - do service klipper restart or /etc/init.d/klipper restart
• 6.6 Build klipper.bin file
  - Building is not mandatory to be done on the device that hosts klippy. To build it on this box you would need a lot of dependencies that are not available for OpenWrt so I just used my pc running ubuntu: On a different computer running linux (or VM or live USB) -> Clone klipper just like you did before -> cd klipper -> make menuconfig -> use the configurations specific to your mainboard (Check the header inside your printer.cfg file for details).
  ❗ use custom baud: 230400. By default 250000 is selected. If you want/need that baud, remove the python-pyserial package and install this version of pyserial instead - check Requirements directory for details about installation process.
  -> once configured run make -> if succesfull the firmware will be inside ./out/klipper.bin -> flash the mainboard:(check header of printer.cfg again - some mainboards need the .bin file renamed a certain way) copy the .bin file on a sd card -> plug the card with the printer off -> turn printer on and wait a minute -> Done (Depending on your mainboard/printer/lcd you will probably not have a sign that the mainboard got flashed so don't worry) - if at the end of this guide the client cannot connect to the klipper firmware usually the problem is with the .bin file building or flashing process.

• 7.1 Clone Moonraker

cd ~
git clone https://github.com/Arksine/moonraker.git

• 7.2 Use provided moonraker.conf file You can find the moonraker.conf files in my repo: /moonraker/*.conf.
  Depending on your chosen client (mainsail or fluidd) rename the respective .conf file to moonraker.confand put it in ~/klipper_config. Note: The [update_manager] plugin was commented out since this is curently only supported for debian distros only. For now, updating moonraker, klipper, fluidd or mainsail should be done manaully.
  Don't forget to edit(if necessary) the moonraker.conf file you copied inside ~/klipper_config under trusted_clients: with your client ip or ip range (client meaning the device you want to access fluidd/mainsail from). Check the moonraker configuration doc for details.

• 7.3 Use provided moonraker service and place inside /etc/init.d/ - find it in my repo inside Services
  Don't forget to give it executable permissions and then to enable it just like you did with klipper service.
  Restart Moonraker service when you're done with service moonraker restart or /etc/init.d/moonraker restart

• 7.4 Create and place all the nginx files inside /etc/nginx/conf.d*
  Make sure you've installed nginx-ssl and a conf.d directory appeared inside /etc/nginx/
  Place fluidd.conf OR mainsail.confinside /etc/nginx/conf.d/ alongside common_vars.conf AND upstreams.conf (those 2 files are common for mainsail and fluidd)- you can find all these files in my repo inside nginx directory.
  Note!
  You need to use either fluidd.conf or mainsail.conf file depending on your chosen client. Don't use both .conf files inside /etc/nginx/conf.d/. If you want to test both clients and easly switch between them check the exclamation mark below.

• 7.5 Clone chosen client:

fluidd

mkdir ~/fluidd
cd ~/fluidd
wget -q -O fluidd.zip https://github.com/cadriel/fluidd/releases/latest/download/fluidd.zip && unzip fluidd.zip && rm fluidd.zip

Mainsail

mkdir ~/mainsail
cd ~/mainsail
wget -q -O mainsail.zip https://github.com/meteyou/mainsail/releases/latest/download/mainsail.zip && unzip mainsail.zip && rm mainsail.zip

Note!
It's ok to keep both client directories inside ~/ as these are static files. Careful with the .conf file inside /etc/nginx/conf.d.

• 7.6 Restart nginx with service nginx restart and check browser if http://your-ip brings you the client interface (fluidd or mainsail).

❗ How to switch between fluidd and mainsail:

1. switch between mainsail.confand fluidd.conf file inside /etc/nginx/conf.d (make sure the other one gets renamed to a different extension. eg: *.conf_off or moved to a different fodler.)
2. Switch between mainsail and fluidd moonraker.conf files inside ~/klipper_config. Find them inside my repo under moonraker directory.
3. Restart moonraker and nginx services: service moonraker restart and service nginx restart

• install video4linux utilities: opkg update && opkg install v4l-utils
• use commands: opkg update && opkg install mjpg-streamer-input-uvc mjpg-streamer-output-http mjpg-streamer-www
• connect a uvc webcam, configure /etc/config/mjpg-streamer to your likings, enable and restart service:

/etc/init.d/mjpg-streamer enable
/etc/init.d/mjpg-streamer restart

• put the stream link inside the client(fluidd/mainsail) camera setting: http://<your_ip>/webcam/?action=stream

• To change your hostname go to /etc/config/system and modify option hostname 'OpenWrt' to your likings.
• To use your hostname in browser and ssh instead of the ip do:

opkg update
opkg install avahi-daemon-service-ssh avahi-daemon-service-http
reboot

• Instead of http://your-ip use http://your_hostname.local

• for Klipper - check the requirements.txt file.

• ❗ Python2 packages are not available by default for this snapshot A workaround I found was to use the v19.07 OpenWrt release feeds (this version still has python2 packages) for the same target (ramips/mt76x8) and cpu architecture (mipsel_24kc) as the box. I make a backup of the original /etc/opkg/distfeeds.conf and create another distfeeds.conffile with the v19.07 url feeds. Don't forget to run opkg update everytime you make modifications to that file. After finishing with installing the packages that are only available for the v19.07 and below (like python2 packages) I switch back to the backup distfeeds.conf file.

• The distfeeds.conf file with openwrt v19.07 feeds should look something like this:

 src/gz openwrt_core http://downloads.openwrt.org/releases/19.07.7/targets/ramips/mt7621/packages   
 src/gz openwrt_freifunk http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/freifunk  
 src/gz openwrt_base http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/base  
 src/gz openwrt_luci http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/luci  
 src/gz openwrt_packages http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/packages  
 src/gz openwrt_routing http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/routing  
 src/gz openwrt_telephony http://downloads.openwrt.org/releases/19.07.7/packages/mipsel_24kc/telephony  

• Do opkg update
  ❗ If you get wrong signature errors, comment the option check_signature line under /etc/opkg.conf - you can uncomment this after finishing with v19.07 distfeeds
• After you add the v19.07 distfeeds.conf -> install python2 packages: with opkg install python python-pip python-cffi python-pyserial python-dev gcc.
  ❗ The official pyserial python package is not configured to work with 250000 baud on MIPS platforms (only 230400 max). If you want/need 250k baud, install this version of pyserial and install it with python2 setup.py install
• With pip install: pip install greenlet==0.4.15 jinja2 python-can=3.3.4
• Switch back to original distfeeds.conf, opkg update -> install python3 and packages: opkg install python3 python3-pip python3-tornado.

• 6.1 Clone Klipper inside ~/
  - do opkg install git-http unzip then git clone https://github.com/KevinOConnor/klipper.git.
• 6.2 Use provided klipper service and place inside /etc/init.d/ - find it inside Services -> klipper
• 6.3 Enable klipper service: Everytime you create a service file you need to give it executable permissions before enabling it. For klipper do chmod 755 klipper. You can enable it now by /etc/init.d/klipper enable
• 6.4 Prepare your printer.cfg file - do mkdir ~/klipper_config and mkdir ~/gcode_files . Locate your .cfg file inside ~/klipper/config/ copy it to ~/klipper_config and rename it to printer.cfg - Inside printer.cfg under [mcu] replace serial line with serial: /dev/ttyUSB0 and add a new line: baud: 230400 - (check requirements if you want/need 250000 baud)
• 6.5 Restart klipper - do service klipper restart or /etc/init.d/klipper restart
• 6.6 Build klipper.bin file - Building is not mandatory to be done on the device that hosts klippy. To build it on this box you would need a lot of dependencies that are not available for OpenWrt so I just used my pc running ubuntu: On a different computer running linux (or VM or live USB) -> Clone klipper just like you did before -> cd klipper -> make menuconfig -> use the configurations specific to your mainboard (Check the header inside your printer.cfg file for details).
  ❗ use custom baud: 230400. By default 250000 is selected. If you want/need that baud, remove the python-pyserial package and install this version of pyserial instead - check Requirements directory for details about installation process. -> once configured run make -> if succesfull the firmware will be inside ./out/klipper.bin -> flash the mainboard:(check header of printer.cfg again - some mainboards need the .bin file renamed a certain way) copy the .bin file on a sd card -> plug the card with the printer off -> turn printer on and wait a minute -> Done (Depending on your mainboard/printer/lcd you will probably not have a sign that the mainboard got flashed so don't worry) - if at the end of this guide the client cannot connect to the klipper firmware usually the problem is with the .bin file building or flashing process.

• Download
  cd ~
git clone https://github.com/Stephan3/dwc2-for-klipper-socket

• Edit dwc2.cfg - set the web_root: path to absolute path: /root/sdcard/web

• Create dwc socket service
  Create a dwc file inside /etc/init.d/ with the contents of the dwc file inside my repo: Services->dwc
  Give it executable permissions: chmod 755 /etc/init.s/dwc
  Enable it: /etc/init.d/dwc enable

• Download dwc version 3 web interface

mkdir -p ~/sdcard/web
cd ~/sdcard/web
wget -O DuetWebControl-SD.zip https://github.com/Duet3D/DuetWebControl/releases/download/3.1.1/DuetWebControl-SD.zip
unzip *.zip && for f_ in $(find . | grep '.gz');do gunzip ${f_};done
rm DuetWebControl-SD.zip

• Restart dwc socket service: service dwc restart or /etc/init.d/dwc restart
• Test: https:://<your_ip>:4750

• To change your hostname go to /etc/config/system and modify option hostname 'OpenWrt' to your likings.
• To use your hostname in browser and ssh instead of the ip do:

opkg update
opkg install avahi-daemon-service-ssh avahi-daemon-service-http
reboot

• Instead of http://your-ip use http://your_hostname.local