femtofox/Getting_started.md

Femtofox - Getting Started

This guide assumes a certain level of familiarity with Meshtastic, and Meshtastic nodes.

The Femtofox is similar to, and can functionally replace, a Raspberry Pi Linux Native Meshtastic node. 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 standard PCB Gerber files and suitable Bills of Materials (BOM) and Pick and Place files for the components. Download the Gerber files from here, selecting the set of files for your application:

• Bare PCB - you have all of the necessary components on hand
• SMD populated PCB - you have a Luckfox Pico Mini and suitable radio module on hand, plus any other headers or connectors desired.
• Radio and header populated PCB - only a Luckfox Pico Mini is required to complete the build. Two sets of files are provided for this, based on the radio module required:
  • 22db (E22-900M22S)
  • 30db (E22-900M30S)

Upload the Gerber .zip file to a PCB maker of your choice, e.g.:

• JLCPCB
• PCBWay
• OSHPark

Prototypes were made using JLCPCB. We recommend selecting 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

Although the Femtofox CE is only licensed for personal use and not for sale, a Femtofox Pro is available for purchase as a fully assembled node, through the following licensed sellers:

1. Open Source Country (USA)
2. NomDeTom (UK)
3. Noon (Central Korea)
4. TBC
5. TBC

The Femtofox Pro has all the same features as the CE, plus a few features that only make sense when ordered at scale [Insert link]. 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 zip file.
2. Use an image flashing tool such as [Balena Etcher] to flash the image to a suitable SD card. 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 serial-USB adaptor to TX/RX/Gnd of UART2 (Femtofox CE) or insert a cable into the power/debug port (Femtofox Pro).
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 Router (???) and connect using an SSH client of your choice.

After first login, run sudo femto-config from the command prompt.

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 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 [link] - a popular auto-responder/query handler/BBS/everything else.
2. TheCommsChannel BBS [link] - a popular BBS application
3. Curses Client for Meshtastic - the simplest, most retro client possible
4. Meshtastic Web

Additional applications...