From 30db0cc9f2c34cfa1fc5c0b7a86ed4cc2f0ca3d3 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:25:04 +0000 Subject: [PATCH 01/14] Getting_started.md created from https://stackedit.io/ --- Getting_started.md | 100 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 Getting_started.md diff --git a/Getting_started.md b/Getting_started.md new file mode 100644 index 0000000..dd58567 --- /dev/null +++ b/Getting_started.md @@ -0,0 +1,100 @@ +## Femtofox - Getting Started +This guide assumes a certain level of familiarity with [Meshtastic](meshtastic.org), and [Meshtastic nodes](https://meshtastic.org/docs/getting-started/). + +The Femtofox is similar to, and can functionally replace, a [Raspberry Pi Linux Native Meshtastic node](https://meshtastic.org/docs/hardware/devices/linux-native-hardware/). However, the Foxbuntu OS takes away most of the heavy lifting of a typical install, leaving you free to build your mesh application without the initial hurdles. + +### Hardware +To get started, you will need a Femtofox. You can either build or buy one. + 1. Building a Femtofox + +Femtofox Community Edition (CE) is provided as a standard PCB Gerber files and suitable Bill of Materials (BOM) and Pick and Place files for the components. + +Download the Gerber files from [here](TBC). + +Upload the Gerber .zip file to a PCB maker of your choice, e.g.: + - JLCPCB + - PCBWay + - OSHPark + +Prototypes were made using JLCPCB. It is recommend to select a board thickness of 1.6mm, and a lead-free HASL surface finish. It is also suggested to select "Remove mark" for order serial numbers, as the Gerbers do not contain a specific location for this marking. + +Select the number of PCBs and the assembly options you require. Minimum PCB quantities are usually 5 boards, although assembly can be as few as 2 boards. + +If required, upload the BOM and Pick&Place files, and check that the suggested parts are available. JLC regularly changes their stocked items, so make sure that, at a minimum, the following are correct for each item: + + - Components are the correct footprint (Resistors and Capacitors are 0603 or 1206, MOSFETS are SOT23) + - Components are the correct rating (see BOM for details) + - Components are in the `basic` series where possible, especially capacitors, resistors and MOSFETs + +Ensure that the components are placed correctly on the PCB, and that the correct radio module is selected, then check and place the order. + +Assemble the PCBs according to the BOM and Pick&Place files, or the photographs below. + +Solder the Luckfox Pico Mini to the headers as low down as possible, to ensure easy access to the SD card. + + +
+ 2. Buying a Femtofox + +The Femtofox Pro is available for purchase, and has several added features: +* Arrives fully assembled +* 4-Layer PCB allows for extra complexity +* USB-C for power and built in serial debug, which allows for direct access to the Femtofox without network or additional hardware +* Extra pins are mapped to the headers, allowing for easier expansion +* An added "Kill Switch" breakout, allowing for the addition of an optional thermal fuse for added safety on solar builds +* Additional decoupling capacitors +The Femtofox Pro is available through the following licensed sellers: + 1. Open Source Country (USA) + 2. NomDeTom (UK) + 3. Noon (Central Korea) + 4. TBC + 5. TBC + +If you require a large quantity of Femtofox boards, please get in touch. +
+ +### Operating System + + 1. Download the latest image of Foxbuntu from the releases [link] and extract from the 7z file with [7z program]. + 2. Use an image flashing tool such as [Balena Etcher] to flash the image to a suitable SD card (see [supported hardware]). + Note that the image will not appear bootable to Etcher, but will be functional in use. + 3. Insert the SD card into the reader of the Femtofox + +### Initial Configuration - Suggested Workflow +Foxbuntu is ready to operate almost from the first boot. The settings can be configured using one of the following methods: + +
+ Command Line + + 1. Serial console - Connect a USB-C cable to the power/serial port (Femtofox Pro) or connect a serial-USB adaptor to TX/RX/Gnd of UART2 (Femtofox CE). + 2. SSH via Ethernet - connect a network cable either through the RJ45 port or by soldering directly to the Ethernet headers of the Luckfox (possible but not recommended) and connect it to your network. Identify the IP address via your DHCP server (e.g. your router) and connect using an SSH client of your choice. + +After first login, run `sudo femto-config` from the command prompt, and launch the setup wizard. + +[ 3. Web tool via Wifi AP mode - if a wifi adaptor is identified at first boot, and no configuration is provided for it, then the Femtofox will automatically generate a wifi hotspot to allow configuration. Connect to the wifi hotspot and access the web config tool using `192.168.4.1` in a browser.]: # +[ 4. SSH via Wifi AP mode - ... ]: # + +
+ +
+ USB Config + +See [this page](./usb_config.md) for details on how to configure via a USB drive. +
+ +### Mesh Applications +Femtofox is supplied with pre-installed copies of many popular applications, such as: + + 1. [Meshing Around](https://github.com/SpudGunMan/meshing-around) - a popular auto-responder/query handler/BBS/everything else. + 2. [TheCommsChannel BBS](https://github.com/TheCommsChannel/TC2-BBS-mesh) - a popular BBS application + 3. [Curses Client for Meshtastic](https://github.com/pdxlocations/curses-client-for-meshtastic) - the simplest, most retro client possible + +Additional applications may be added to the default image in future. + +### Updating +Foxbuntu, Meshtasticd and the mesh applications can be updated as using the `Femto-Config` tool. + + + \ No newline at end of file From e1cf427cd3d0c9f3959e6b7fcf713ce35c44ecd9 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:26:38 +0000 Subject: [PATCH 02/14] Getting_started.md updated from https://stackedit.io/ --- Getting_started.md | 29 ++--------------------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/Getting_started.md b/Getting_started.md index dd58567..e51861a 100644 --- a/Getting_started.md +++ b/Getting_started.md @@ -6,32 +6,7 @@ The Femtofox is similar to, and can functionally replace, a [Raspberry Pi Linux ### Hardware To get started, you will need a Femtofox. You can either build or buy one. 1. Building a Femtofox - -Femtofox Community Edition (CE) is provided as a standard PCB Gerber files and suitable Bill of Materials (BOM) and Pick and Place files for the components. - -Download the Gerber files from [here](TBC). - -Upload the Gerber .zip file to a PCB maker of your choice, e.g.: - - JLCPCB - - PCBWay - - OSHPark - -Prototypes were made using JLCPCB. It is recommend to select a board thickness of 1.6mm, and a lead-free HASL surface finish. It is also suggested to select "Remove mark" for order serial numbers, as the Gerbers do not contain a specific location for this marking. - -Select the number of PCBs and the assembly options you require. Minimum PCB quantities are usually 5 boards, although assembly can be as few as 2 boards. - -If required, upload the BOM and Pick&Place files, and check that the suggested parts are available. JLC regularly changes their stocked items, so make sure that, at a minimum, the following are correct for each item: - - - Components are the correct footprint (Resistors and Capacitors are 0603 or 1206, MOSFETS are SOT23) - - Components are the correct rating (see BOM for details) - - Components are in the `basic` series where possible, especially capacitors, resistors and MOSFETs - -Ensure that the components are placed correctly on the PCB, and that the correct radio module is selected, then check and place the order. - -Assemble the PCBs according to the BOM and Pick&Place files, or the photographs below. - -Solder the Luckfox Pico Mini to the headers as low down as possible, to ensure easy access to the SD card. - +Directions for ordering PCBs and building a Femtofox can be found in the [Community Hardware repo](https://github.com/femtofox/Femtofox_Community_Hardware).
2. Buying a Femtofox @@ -96,5 +71,5 @@ Foxbuntu, Meshtasticd and the mesh applications can be updated as using the `Fem \ No newline at end of file From 30c625ff59f638b9cbb5aba58beb3cfb064ee564 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:28:10 +0000 Subject: [PATCH 03/14] Getting_started.md updated from https://stackedit.io/ --- Getting_started.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Getting_started.md b/Getting_started.md index e51861a..6e31ede 100644 --- a/Getting_started.md +++ b/Getting_started.md @@ -18,6 +18,7 @@ The Femtofox Pro is available for purchase, and has several added features: * Extra pins are mapped to the headers, allowing for easier expansion * An added "Kill Switch" breakout, allowing for the addition of an optional thermal fuse for added safety on solar builds * Additional decoupling capacitors + The Femtofox Pro is available through the following licensed sellers: 1. Open Source Country (USA) 2. NomDeTom (UK) @@ -30,7 +31,7 @@ If you require a large quantity of Femtofox boards, please get in touch. ### Operating System - 1. Download the latest image of Foxbuntu from the releases [link] and extract from the 7z file with [7z program]. + 1. Download the latest image of Foxbuntu from the releases [https://github.com/femtofox/Femtofox/releases/] and extract from the 7z file with [7z program](https://www.7-zip.org/) or suitable alternative. 2. Use an image flashing tool such as [Balena Etcher] to flash the image to a suitable SD card (see [supported hardware]). Note that the image will not appear bootable to Etcher, but will be functional in use. 3. Insert the SD card into the reader of the Femtofox @@ -71,5 +72,5 @@ Foxbuntu, Meshtasticd and the mesh applications can be updated as using the `Fem \ No newline at end of file From 97d0c518c48723d2222d302de4b8bcb53042a578 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:29:42 +0000 Subject: [PATCH 04/14] Getting_started.md updated from https://stackedit.io/ --- Getting_started.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Getting_started.md b/Getting_started.md index 6e31ede..bd5ec34 100644 --- a/Getting_started.md +++ b/Getting_started.md @@ -32,9 +32,9 @@ If you require a large quantity of Femtofox boards, please get in touch. ### Operating System 1. Download the latest image of Foxbuntu from the releases [https://github.com/femtofox/Femtofox/releases/] and extract from the 7z file with [7z program](https://www.7-zip.org/) or suitable alternative. - 2. Use an image flashing tool such as [Balena Etcher] to flash the image to a suitable SD card (see [supported hardware]). - Note that the image will not appear bootable to Etcher, but will be functional in use. - 3. Insert the SD card into the reader of the Femtofox + 2. Use an image flashing tool such as [Balena Etcher](https://www.balena.io/etcher) to flash the image to a suitable SD card (see [supported hardware](./supported_hardware.md)). + Note: the image will not appear bootable to Etcher, but will be functional in use. + 3. Insert the SD card into the reader of the Femtofox. ### Initial Configuration - Suggested Workflow Foxbuntu is ready to operate almost from the first boot. The settings can be configured using one of the following methods: @@ -72,5 +72,5 @@ Foxbuntu, Meshtasticd and the mesh applications can be updated as using the `Fem \ No newline at end of file From a1e06971bb3826af6ca21b53c4aef432820d3574 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:30:25 +0000 Subject: [PATCH 05/14] Getting_started.md updated from https://stackedit.io/ --- Getting_started.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Getting_started.md b/Getting_started.md index bd5ec34..58c0fae 100644 --- a/Getting_started.md +++ b/Getting_started.md @@ -5,6 +5,7 @@ The Femtofox is similar to, and can functionally replace, a [Raspberry Pi Linux ### Hardware To get started, you will need a Femtofox. You can either build or buy one. + 1. Building a Femtofox Directions for ordering PCBs and building a Femtofox can be found in the [Community Hardware repo](https://github.com/femtofox/Femtofox_Community_Hardware). @@ -72,5 +73,5 @@ Foxbuntu, Meshtasticd and the mesh applications can be updated as using the `Fem \ No newline at end of file From c57e2cfd0c7a7fbdef840facffe32af9f7850c5d Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Tue, 28 Jan 2025 23:00:48 +0000 Subject: [PATCH 06/14] README.md updated from https://stackedit.io/ --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index fabacd4..bc811ff 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,11 @@ In Meshtasticd's config.yaml we use GPIO bank 1, and subtract 32 from the pin nu ![pinout](assets/images/luckfox_pinout.png) ![pinout](assets/images/luckfox_pico_mini_original_wiring_diagram.jpg) +![pinout](/assets/images/femtofox_pinout.png) > [!NOTE] > The information on this page is given without warranty or guarantee. Links to vendors of products are for informational purposes only. > Meshtastic® is a registered trademark of Meshtastic LLC. Meshtastic software components are released under various licenses, see GitHub for details. No warranty is provided - use at your own risk. + \ No newline at end of file From 51206de9d0b8df9a11ee4b0808107256f8ab94a2 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Sun, 2 Feb 2025 22:49:51 +0000 Subject: [PATCH 07/14] Update foxbuntu_install.md --- foxbuntu_install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/foxbuntu_install.md b/foxbuntu_install.md index add4de2..d25adb0 100644 --- a/foxbuntu_install.md +++ b/foxbuntu_install.md @@ -12,7 +12,7 @@ To install Foxbuntu, you'll need the following: 4. A Femtofox (duh!) ### Installation instructions -1. Download the latest stable [Foxbuntu release](https://github.com/noon92/femtofox/releases). At the bottom of the release, click the .7z file to download. +1. Download the latest stable [Foxbuntu release](https://github.com/femtofox/femtofox/releases). At the bottom of the release, click the .7z file to download. 2. Flash the image your MicroSD card using [Balena Etcher](https://etcher.balena.io/) or your favorite flashing program. You will likely get a warning that the image appears to be invalid or has no partition table. This is normal. 3. Insert the microSD card into the Luckfox Pico Mini. The microSD slot is on the back of the board. 4. Configure the Femtofox using one of the following methods: From 679506e3261bbebb00ec8761622c5606dd536f3f Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Sun, 2 Feb 2025 23:10:45 +0000 Subject: [PATCH 08/14] Update README.md --- README.md | 24 +----------------------- 1 file changed, 1 insertion(+), 23 deletions(-) diff --git a/README.md b/README.md index bc811ff..962b7a2 100644 --- a/README.md +++ b/README.md @@ -53,31 +53,9 @@ There are four methods to get online: ### [Installation guide](foxbuntu_install.md) -### Pinout: -|Pin #|Pin ID |Function |Luckfox |Pin #|Pin ID |Function | -|-----|-------|--------------|--------|-----|-------|--------------| -|1 |VBus |5V in/out | |22 |1V8 |1.8V out | -|2 |GND | | |21 |GND | | -|3 |3V3 |3.3V out | |20 |4C1 |1v8 IO, SARADC| -|4/42 |1B2 |Debug UART2-TX| |19 |4C0 |1v8 IO, SARADC| -|5/43 |1B3 |Debug UART2-RX| |18/4 |0A4 |3v3 IO | -|6/48 |1C0 |CS0, IO | |17/55|1C7 |IRQ, IO | -|7/49 |1C1 |CLK, IO | |16/54|1C6 |BUSY, IO | -|8/50 |1C2 |MOSI, IO | |15/59|1D3 |i2c SCL | -|9/51 |1C3 |MISO, IO | |14/58|1D2 |i2c SDA | -|10/52|1C4 |UART4-TX | |13/57|1D1 |UART3-RX, NRST| -|11/53|1C5 |UART4-RX | |12/56|1D0 |UART3-TX, RXEN| - -Pin ID explanation: **1C6** = GPIO bank **1**, group **C**, pin **6**. -In Meshtasticd's config.yaml we use GPIO bank 1, and subtract 32 from the pin number. - -![pinout](assets/images/luckfox_pinout.png) -![pinout](assets/images/luckfox_pico_mini_original_wiring_diagram.jpg) -![pinout](/assets/images/femtofox_pinout.png) - > [!NOTE] > The information on this page is given without warranty or guarantee. Links to vendors of products are for informational purposes only. > Meshtastic® is a registered trademark of Meshtastic LLC. Meshtastic software components are released under various licenses, see GitHub for details. No warranty is provided - use at your own risk. \ No newline at end of file +--> From b8ac2f0a717a67c011c47210360640974212dc99 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Sun, 2 Feb 2025 23:26:17 +0000 Subject: [PATCH 09/14] Delete Getting_started.md --- Getting_started.md | 77 ---------------------------------------------- 1 file changed, 77 deletions(-) delete mode 100644 Getting_started.md diff --git a/Getting_started.md b/Getting_started.md deleted file mode 100644 index 58c0fae..0000000 --- a/Getting_started.md +++ /dev/null @@ -1,77 +0,0 @@ -## Femtofox - Getting Started -This guide assumes a certain level of familiarity with [Meshtastic](meshtastic.org), and [Meshtastic nodes](https://meshtastic.org/docs/getting-started/). - -The Femtofox is similar to, and can functionally replace, a [Raspberry Pi Linux Native Meshtastic node](https://meshtastic.org/docs/hardware/devices/linux-native-hardware/). However, the Foxbuntu OS takes away most of the heavy lifting of a typical install, leaving you free to build your mesh application without the initial hurdles. - -### Hardware -To get started, you will need a Femtofox. You can either build or buy one. - - 1. Building a Femtofox -Directions for ordering PCBs and building a Femtofox can be found in the [Community Hardware repo](https://github.com/femtofox/Femtofox_Community_Hardware). - -
- 2. Buying a Femtofox - -The Femtofox Pro is available for purchase, and has several added features: -* Arrives fully assembled -* 4-Layer PCB allows for extra complexity -* USB-C for power and built in serial debug, which allows for direct access to the Femtofox without network or additional hardware -* Extra pins are mapped to the headers, allowing for easier expansion -* An added "Kill Switch" breakout, allowing for the addition of an optional thermal fuse for added safety on solar builds -* Additional decoupling capacitors - -The Femtofox Pro is available through the following licensed sellers: - 1. Open Source Country (USA) - 2. NomDeTom (UK) - 3. Noon (Central Korea) - 4. TBC - 5. TBC - -If you require a large quantity of Femtofox boards, please get in touch. -
- -### Operating System - - 1. Download the latest image of Foxbuntu from the releases [https://github.com/femtofox/Femtofox/releases/] and extract from the 7z file with [7z program](https://www.7-zip.org/) or suitable alternative. - 2. Use an image flashing tool such as [Balena Etcher](https://www.balena.io/etcher) to flash the image to a suitable SD card (see [supported hardware](./supported_hardware.md)). - Note: the image will not appear bootable to Etcher, but will be functional in use. - 3. Insert the SD card into the reader of the Femtofox. - -### Initial Configuration - Suggested Workflow -Foxbuntu is ready to operate almost from the first boot. The settings can be configured using one of the following methods: - -
- Command Line - - 1. Serial console - Connect a USB-C cable to the power/serial port (Femtofox Pro) or connect a serial-USB adaptor to TX/RX/Gnd of UART2 (Femtofox CE). - 2. SSH via Ethernet - connect a network cable either through the RJ45 port or by soldering directly to the Ethernet headers of the Luckfox (possible but not recommended) and connect it to your network. Identify the IP address via your DHCP server (e.g. your router) and connect using an SSH client of your choice. - -After first login, run `sudo femto-config` from the command prompt, and launch the setup wizard. - -[ 3. Web tool via Wifi AP mode - if a wifi adaptor is identified at first boot, and no configuration is provided for it, then the Femtofox will automatically generate a wifi hotspot to allow configuration. Connect to the wifi hotspot and access the web config tool using `192.168.4.1` in a browser.]: # -[ 4. SSH via Wifi AP mode - ... ]: # - -
- -
- USB Config - -See [this page](./usb_config.md) for details on how to configure via a USB drive. -
- -### Mesh Applications -Femtofox is supplied with pre-installed copies of many popular applications, such as: - - 1. [Meshing Around](https://github.com/SpudGunMan/meshing-around) - a popular auto-responder/query handler/BBS/everything else. - 2. [TheCommsChannel BBS](https://github.com/TheCommsChannel/TC2-BBS-mesh) - a popular BBS application - 3. [Curses Client for Meshtastic](https://github.com/pdxlocations/curses-client-for-meshtastic) - the simplest, most retro client possible - -Additional applications may be added to the default image in future. - -### Updating -Foxbuntu, Meshtasticd and the mesh applications can be updated as using the `Femto-Config` tool. - - - \ No newline at end of file From d93c531b2ccae3aeaed6740393fa944945182a76 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Sun, 2 Feb 2025 23:31:26 +0000 Subject: [PATCH 10/14] Delete foxbuntu_install.md --- foxbuntu_install.md | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 foxbuntu_install.md diff --git a/foxbuntu_install.md b/foxbuntu_install.md deleted file mode 100644 index d25adb0..0000000 --- a/foxbuntu_install.md +++ /dev/null @@ -1,25 +0,0 @@ - -## Foxbuntu Installation Guide -### Requirements for installing Foxbuntu -To install Foxbuntu, you'll need the following: -1. microSD card. You can select one from [supported hardware](supported_hardware.md), but any card over 8gb and supporting UHS-I *should* work - 2. microSD card reader for your computer - 3. A method to configure the Fox: - * USB OTG adapter (USB-C to USB-A) and a USB flash drive, OR - * USB-C cable to connect the Fox to your computer (Femtofox Pro only), OR - * USB UART serial adapter connected to UART2 (serial debug pins), OR - * An ethernet cable (models with ethernet port) -4. A Femtofox (duh!) - -### Installation instructions -1. Download the latest stable [Foxbuntu release](https://github.com/femtofox/femtofox/releases). At the bottom of the release, click the .7z file to download. -2. Flash the image your MicroSD card using [Balena Etcher](https://etcher.balena.io/) or your favorite flashing program. You will likely get a warning that the image appears to be invalid or has no partition table. This is normal. -3. Insert the microSD card into the Luckfox Pico Mini. The microSD slot is on the back of the board. -4. Configure the Femtofox using one of the following methods: - * For USB config, following the instructions on the [USB Configuration Tool](usb_config.md) page, prepare your USB flash drive with your desired settings. Using a USB OTG adapter, plug the USB flash drive into the *data* USB port (the port on the Luckfox. - * On Femtofox Pro, connect the *Power USB-C port* to your PC with a cable, and open a serial console application such as PuTTY for windows. Select your the Femtofox's COM port (find the correct COM port in Windows hitting WIN+R and entering `cmd /k wmic path Win32_SerialPort get DeviceID, Description && pause`. The port should be named "USB-SERIAL CH340". - * Use a USB UART serial adapter to connect to UART2 (serial debug pins). - * Use an ethernet cable and SSH in. Femtofox's default hostname is femtofox.local. -5. Connect the Femtofox to power, either via the *power USB-C port* (Pro model only, on the same side as the ethernet port) or via the power-in JST power plug. Using the USB-C port on the Luckfox is possible, but will prevent usage of USB peripherals. -6. The Femtofox will perform its first boot. This can take up to 5 minutes (subsequent boots ~40 seconds). When boot is complete, the USR LED will blink 5 times, 1/2 a second each. -7. Default username and password is `femto`:`femto`. You are required to change the password on first login. From ef76f85fdd202b211e0294ce3cd44f5f6b7281cc Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Sun, 2 Feb 2025 23:31:36 +0000 Subject: [PATCH 11/14] Delete supported_hardware.md --- supported_hardware.md | 108 ------------------------------------------ 1 file changed, 108 deletions(-) delete mode 100644 supported_hardware.md diff --git a/supported_hardware.md b/supported_hardware.md deleted file mode 100644 index 741bf46..0000000 --- a/supported_hardware.md +++ /dev/null @@ -1,108 +0,0 @@ -## Supported Hardware -| Hardware | Confirmed working | Expected to work | Notes | -|-|-|-|--| -|LoRa radios (working with Meshtasticd)|
  • [Waveshare RPi LoRa hat without GNSS](https://www.waveshare.com/sx1262-lorawan-hat.htm?sku=22002)*
  • [Seeed Wio SX1262](https://www.seeedstudio.com/Wio-SX1262-Wireless-Module-p-5981.html)
  • [Ebyte E220900M30S](https://aliexpress.com/item/4000543921245.html)
  • AI Thinker RA-01SH
  • [Heltec HT-RA62](https://www.aliexpress.com/item/1005005445349105.html)|
  • Ebyte E22-900mm22s
  • [Ebyte E22-900m22s](https://www.aliexpress.com/item/1005001808069127.html)
  • Any SPI LoRa radio that's Meshtastic compatible|*Waveshare RPi hat is not recommended as it has issues with sending longer messages.| -|MicroSD cards|
  • [Kingston Endurance 32gb](https://www.kingston.com/en/memory-cards/high-endurance-microsd-card)
  • [Sandisk Ultra UHS-I 32gb](https://shop.sandisk.com/products/memory-cards/microsd-cards/sandisk-ultra-uhs-i-microsd?sku=SDSQUA4-032G-GN6MA)|Any reasonably fast (UHS-I or better) card with 8gb or more|Stick with reputable manufacturers (Kingston, PNY Samsung, Sandisk, Transcend...)
    The faster the better! Consider sticking with "endurance" cards, especially for remotely deployed nodes.| -|RTC (real time clock)|
  • [DS3231M](https://vi.aliexpress.com/item/1005007143842437.html)
  • [DS1307](https://vi.aliexpress.com/item/1005007143542894.html)|DS1337, DS1338, DS1340, other DS3231 variants |Some DS3231 modules are listed as having a supercapacitor - these are usually actually lithium coin cells.| -|Meshtastic nodes|USB+UART: [RAK4631 with RAK19007 or RAK19003 base board](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit)| |RAK4630 and 4631 are the same.| -|USB wifi adapter chipsets|||See below| | -|Misc. hardware|
  • USB hubs (powered or not)
  • Thumb drives
  • SD card readers||If power draw exceeds supply, the device will reboot, bootloop or hard crash. Unpowered USB hubs seem to be notorious for causing reboots.
    Some users have reported that USB-C flash drives do not work. This requires more study.| - -### Wifi chipsets -The following wifi chipsets/devices have their drivers included in the OS images. Most of these have not been tested. Note that power consumption metrics are for a specific version of a chipset and may not apply to all implementations. - -|Chipset: |Tested?|Recommended?|Power usage |Notes| -|-----------------------|-------|------------|------------|-----| -|**Realtek:** | | | | | -|rtl8187 | | | | | -|rtl8187b | | | | | -|rtl8188[cr]u | | | | | -|rtl8188cu | | | | | -|rtl8188ee | | | | | -|rtl8188eu
    rtl8188eus
    rtl8188cus|✔️|✔️|Idle: 0.25w
    TXing: 0.4w
    Off: 0.026w|Model tested:
    [TP-LINK TL-WN725N **V2**](https://techinfodepot.shoutwiki.com/wiki/TP-LINK_TL-WN725N_v2): working
    [TP-Link TL-WR722N **V4**](https://techinfodepot.shoutwiki.com/wiki/TP-LINK_TL-WN722N_v1.x): working (v2, v3 *should* be identical)| -|rtl8188ru | | | | | -|rtl819[12]cu | | | | | -|rtl8191cu | | | | | -|rtl8192ce | | | | | -|rtl8192cu |✔️ |❔ | |Tested:
    [Edimax EW-7811Un](https://techinfodepot.shoutwiki.com/wiki/Edimax_EW-7811Un): working| -|rtl8192de | | | | | -|rtl8192e | | | | | -|rtl8192ee | | | | | -|rtl8192eu |✔️ |❌ | |Buggy| -|rtl8192se | | | | | -|rtl8273,8188,8191,8192 | | | | | -|rtl8712u | | | | | -|rtl8723ae | | | | | -|rtl8723au | | | | | -|rtl8723be | | | | | -|rtl8812bu |✔️ |❌ | |Tested:
    [TP-LINK Archer T3U](https://techinfodepot.shoutwiki.com/wiki/TP-LINK_Archer_T3U): **NOT** working| -|rtl8821ae | | | | | -|rtl8821au |✔️ |❌ | |Tested:
    [TP-Link Archer T2U Plus](https://www.tp-link.com/us/home-networking/usb-adapter/archer-t2u-plus/): **NOT** working| -|rtl8xxx other | | | | | -| | | | | | -|**Mediatek:** | | | | | -|mt7601u |✔️ |✔️ |Idle: 0.739w|Tested:
    [Genbasic RF 2A4M1](https://www.amazon.com/dp/B0BNFKJPXS): working| -|mt76x0u | | | | | -|mt76x2u | | | | | -|mt7663s | | | | | -|mt7663u | | | | | -| | | | | | -|**Atheros:** | | | | | -|ar5008 | | | | | -|ar5523 | | | | | -|ar6003 | | | | | -|ar6004 | | | | | -|ar9001 | | | | | -|ar9002 | | | | | -|ar9170 | | | | | -|ar9271 |✔️ |❔ | |Tested:
    [TP-Link TL-WR722N **V1**](https://techinfodepot.shoutwiki.com/wiki/TP-LINK_TL-WN722N_v1.x): working
    [Penguin Wireless TPE-N150USB](https://www.thinkpenguin.com/gnu-linux/penguin-wireless-n-usb-adapter-gnu-linux-tpe-n150usb): buggy
    [Generic AR9271 w/SMA antenna](https://www.aliexpress.com/item/1005007556237899.html): buggy
    Work in progress| -|ar9k | | | | | -|ath11k | | | | | -|ar10k | | | | | -|wcn3660 | | | | | -|wcn3680 | | | | | -| | | | | | -|**Ralink:** | | | | | -|rt2501/rt73 | | | | | -|rt2571 | | | | | -|rt2571w | | | | | -|rt2572 | | | | | -|rt2573 | | | | | -|rt25xx | | | | | -|rt2671 | | | | | -|rt27xx | | | | | -|rt28xx | | | | | -|rt28xx unknown | | | | | -|rt30xx | | | | | -|rt3070 |✔️ |❔ | |Tested:
    [Alfa AWUS036NEH](https://techinfodepot.shoutwiki.com/wiki/ALFA_Network_AWUS036NEH): buggy| -|rt33xx | | | | | -|rt3573 | | | | | -|rt35xx | | | | | -|rt53xx | | | | | -|rt55xx | | | | | -| | | | | | -|**Atmel:** | | | | | -|at76c503 | | | | | -|at76c505 | | | | | -|at76c505a | | | | | -| | | | | | -|**Microchip Atmel:**| | | | | -|wilc1000 | | | | | -| | | | | | -|**Zydas:** | | | | | -|zd1201 | | | | | -|zd1211 | | | | | -|zd1211b | | | | | -| | | | | | -|**RNDIS USB:** | | | | | -|Asus WL169gE | | | | | -|Belkin F5D7051 | | | | | -|BT Voyager 1055 | | | | | -|Buffalo WLI-U2-KG125S | | | | | -|BUFFALO WLI-USB-G54 | | | | | -|Eminent EM4045 | | | | | -|Linksys WUSB54GSC | | | | | -|Linksys WUSB54GSv1 | | | | | -|Linksys WUSB54GSv2 | | | | | -|U.S. Robotics USR5420 | | | | | -|U.S. Robotics USR5421 | | | | | From 85e526af6cb36abf86399184d22cb1b6d353e027 Mon Sep 17 00:00:00 2001 From: Tom <116762865+Nestpebble@users.noreply.github.com> Date: Mon, 3 Feb 2025 00:02:22 +0000 Subject: [PATCH 12/14] Delete usb_config.md --- usb_config.md | 88 --------------------------------------------------- 1 file changed, 88 deletions(-) delete mode 100644 usb_config.md diff --git a/usb_config.md b/usb_config.md deleted file mode 100644 index 1ace2d6..0000000 --- a/usb_config.md +++ /dev/null @@ -1,88 +0,0 @@ - - -## USB Configuration Tool -To configure some Femtofox settings such as wifi, you can insert a USB flash drive containing a configuration file. On boot, the system will automatically recognize, mount and implement the settings you specify. The tool can also be run from the `femto-config` tool, in the `Utilities` menu. - -Configurable settings are: -- Wifi SSID -- Wifi PSK (password) -- Wifi country -- Timezone -- Activity LED (blinky light - disable for minor power savings) -- Meshtastic: - - [LoRa radio model](https://github.com/femtofox/femtofox/blob/main/supported_hardware.md) - - [URL](https://meshtastic.org/docs/software/python/cli/#--seturl-seturl) (used to configure LoRa settings/channels and generate the QR code) - - Security: [public key](https://meshtastic.org/docs/configuration/radio/security/#public-key) - - Security: [private key](https://meshtastic.org/docs/configuration/radio/security/#private-key) - - Security: Add [Admin Key](https://meshtastic.org/docs/configuration/radio/security/#admin-key) - - Security: Clear Admin Key List - - Security: [Legacy Admin Channel](https://meshtastic.org/docs/configuration/radio/security/#admin-channel-enabled) enable/disable - -### Instructions -The USB drive must be formatted with a single FAT32, exFAT, NTFS (read only - log will not be saved to drive) or ext4 partition. Add a file named `femtofox-config.txt` and whichever settings you would like to change (CaSe sEnSiTiVe). - -[Get an example USB configuration file here](assets/femtofox-config.txt) -``` -wifi_ssid="Your SSID name" -wifi_psk="wifipassword" -wifi_country="US" -timezone="America/New_York" -act_led="enable" -meshtastic_lora_radio="ebyte-e22-900m30s" -meshtastic_url="https://meshtastic.org/e/#CgMSAQESCAgBOAFAA0gB" -#meshtastic_public_key="XX=" -#meshtastic_private_key="XX=" -meshtastic_admin_key="XX=" -meshtastic_legacy_admin="true" -dont_run_if_log_exists="true" -``` -> [!NOTE] -> Enter as many or as few settings as you like. -> -> For `wifi_country`, insert your country's [ISO/IEC alpha2 two letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) (such as US, GB, DE, IN, etc.) in capital letters. -> -> Use a timezone as it appears in [the tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). -> ->   **Meshtastic** -> For `meshtastic_lora_radio`, choose your radio from the supported hardware list. -> Options are: -> `ebyte-e22-900m30s` -> `ebyte-e22-900m22s` -> `ebyte-e80-900m22s` (experimental) -> - `heltec-ht-ra62` -> `seeed-wio-sx1262` -> `waveshare-sx126x-xxxm` -> `ai-thinker-ra-01sh` -> `sx1262_tcxo` (for Ebyte E22-900M30SM, Ebyte E22-900M22S, Heltec HT-RA62, Seeed Wio SX1262) -> - `sx1262_xtal` (for AiThinker RA01SH, and Waveshare Pi hat) -> - `lr1121_tcxo` (experimental, for Ebyte E80-900M2213S) -> - `none` _(for simulated radio) -> -> Clearing the `meshtastic_admin_key` list: The admin key list can contain up to three keys - if more are added they will be ignored. The USB configuration tool supports clearing the admin key list, after which you will need to re-add your admin key/s in a second operation. To clear the admin key list, enter `meshtastic_admin_key="clear"`. - -> [!NOTE] -> `dont_run_if_log_exists="true"` will prevent the USB configuration tool from working if there's a log present on the USB drive, indicating it has already been run. There is also an LED boot code for this, described below. - -**To apply your configuration, reboot the Femtofox with the USB drive plugged in, or run `sudo femto-config` - `Utilites` - `Run USB configuration tool`. No other USB drives can be plugged in at the same time.** -A log (`femtofox-config.log`) is saved to `/home/femto` and the USB drive (except on NTFS, which is read only). -
    -### Boot codes -When the Femtofox is finished booting, it will blink its User LED (see below) in a pattern which can be used to gather info on its status or help diagnose issues. -![LEDs](assets/images/leds.png) -| LED blink pattern | Meaning | Possible causes | Solutions | -|--|--|--|--| -|

    ⚠️
    **──────────**
    1 very long blink, lasting 5 seconds | Failed to mount USB drive. Ignoring. | • Invalid filesystem
    • Corrupted partition table
    • Defective USB drive
    • Defective USB OTG adapter | • Use a supported partition (FAT32, exFAT, NTFS, ext4)
    • Repair partition table
    • Try another USB drive
    • Try another USB OTG adapter | -|

    ⚠️
    **───   ───**
    2 long blinks, each lasting 1.5 seconds | femtofox-config.txt is configured to skip if log exists. | USB drive mounted successfully but femtofox-config.txt contains `dont_run_if_log_exists="true"` and a log is present on the USB drive. Ignoring. | Remove log from USB drive or remove `dont_run_if_log_exists` line from femtofox-config.txt | -|

    ⚠️
    **───   ───   ───**
    3 long blinks, each lasting 1.5 seconds | USB drive mounted successfully but femtofox-config.txt was not found. Ignoring. | Config file missing. | Create configuration file as described above. | -|

    ⚠️
    **───   ───   ───   ───   ───**
    5 long blinks, each lasting 1.5 seconds | USB drive mounted successfully and femtofox-config.txt was found but did not contain readable configuration data. Ignoring. | Configuration file improperly formatted or contains no data. | Check configuration file contents as described above. | -|

    ⚠️
    **──   ──   -   -**
    2 long blinks, each lasting 1 second, then 2 short blinks, each lasting 1/4 of a second. Repeats twice | Error while trying to implement a Meshtastic setting after 3 attempts. Some settings may have been implemented successfully. | • The error may be transient.
    • Configuration file may contain improper data. | • Try again.
    • Check configuration file contents as described above.
    • Check the log.

    This pattern may flash before other patterns. The pattern will repeat once for each failed setting. | -|

    ✅
    **·   ·   ·   ·   ·   ·   ·   ·   ·   ·**
    10 very fast blinks, each lasting 1/8th of a second | USB drive mounted successfully, and femtofox-config.txt was found and contained configuration data which was sent for deployment. Any affected services will now restart. You can disconnect the USB drive. | This does not mean that the information in the config file is correct - only that it was readable.
    Note that the "success" boot code will flash if at least one setting is successfully read - even if the setting was not implemented successfully. | | -|

    ✅
    **─   ─   ─   ─   ─**
    5 medium blinks, each lasting 0.5 seconds | Boot complete. Appears on every successful boot and always appears last.| | Hooray! | -> \[!NOTE\] -> Boot codes can appear in sequence - for example: one long (4 second) blink, followed by 5 medium (half second) blinks means the USB drive failed to mount, and that the boot sequence is complete. -