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 Directions for ordering PCBs and building a Femtofox can be found in the Community Hardware repo.

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 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: 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.

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 - a popular auto-responder/query handler/BBS/everything else.
2. TheCommsChannel BBS - a popular BBS application
3. 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.