fetchtastic 0.2.0

Meshtastic Firmware and APK Downloader

Fetchtastic

Fetchtastic is a utility for downloading and managing the latest Meshtastic Android app and Firmware releases. It also provides optional notifications via NTFY.

Table of Contents

• Installation
  • Termux Installation (Android)
  • Windows/Mac/Linux Installation
• Usage
  • Setup Process
  • Command List
  • Files and Directories
  • Scheduling with Cron
  • Notifications via NTFY
• Contributing

Installation

Termux Installation (Android)

Fetchtastic can be installed on your Android device using Termux.

Prerequisites

1. Install Termux: Download and install Termux from F-Droid.
2. Install Termux Boot: Download and install Termux Boot from F-Droid.
3. Install Termux API: Download and install Termux API from F-Droid.
4. (Optional) Install ntfy: Download and install ntfy from F-Droid.

Install Dependencies

Open Termux and run:

pkg install python python-pip openssl -y

Install Fetchtastic

pip install fetchtastic

Windows/Mac/Linux Installation

Fetchtastic can also be installed on Windows, macOS, or Linux systems.

Install with pipx (Recommended)

It's recommended to use pipx to install Fetchtastic in an isolated environment.

1. Install pipx:

   Follow the installation instructions for your platform on the pipx documentation page.

   Restart your terminal or command prompt after installing pipx.

2. Install Fetchtastic with pipx:

   pipx install fetchtastic
   

Install with pip

Alternatively, you can install Fetchtastic using pip:

pip install fetchtastic

Usage

Setup Process

Run the setup command and follow the prompts to configure Fetchtastic:

fetchtastic setup

During setup, you will be able to:

• Choose whether to download APKs, firmware, or both.
• Select specific assets to download.
• Set the number of versions to keep (default is 2 on Termux, 3 on desktop platforms).
• Configure automatic extraction of firmware files. (Optional)
• Set up notifications via NTFY. (Optional)
  • Choose to receive notifications only when new files are downloaded. (Optional)
• Add a cron job to run Fetchtastic regularly. (Optional)
  • On Termux, Fetchtastic can be scheduled to run daily at 3 AM using Termux's cron.
  • On Windows/Mac/Linux, Fetchtastic can be scheduled using the system's cron scheduler.

Command List

• setup: Run the setup process.
• download: Download firmware and APKs.
• topic: Display the current NTFY topic.
• clean: Remove configuration, downloads, and cron jobs.
• version: Display Fetchtastic version.
• help: Show help and usage instructions.

Files and Directories

By default, Fetchtastic saves files and configuration in the Downloads/Meshtastic directory:

• Configuration File: Downloads/Meshtastic/fetchtastic.yaml
• Log File: Downloads/Meshtastic/fetchtastic.log
• APKs: Downloads/Meshtastic/apks
• Firmware: Downloads/Meshtastic/firmware

You can manually edit the configuration file to change the settings.

Scheduling with Cron

During setup, you have the option to add a cron job that runs Fetchtastic daily at 3 AM.

Termux

The setup process will configure the cron job using Termux's cron implementation.

To modify the cron job, you can run:

crontab -e

Windows

You can schedule Fetchtastic to run automatically using the Task Scheduler.

1. Open Task Scheduler.
2. Create a new Basic Task.
3. Set the action to Start a program and enter fetchtastic download.

macOS/Linux

The setup process will configure the cron job using the system's cron scheduler.

To modify the cron job, you can run:

crontab -e

Notifications via NTFY

If you choose to set up notifications, Fetchtastic will send updates to your specified NTFY topic.

• You can subscribe to the topic using the ntfy app or by visiting the topic URL in a browser.
• You can choose to receive notifications only when new files are downloaded.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.