Rail Yard

MicroPython REST API for controlling a Rail Yard from a Raspberry Pi Pico W
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

MicroPython REST API hosted from a Raspberry Pi Pico W capable of controlling Rail Yard devices.

Rail Yard is an iOS app that communicates with the REST API. Download the app here:

(back to top)

Getting Started

There are some macOS prerequisites before installing the firmware and build files on your Raspberry Pi Pico W. Once these are completed, you can skip straight to Installation.

Prerequisites

Install homebrew & Python

Install homebrew:

• /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Install Python:

• brew install python

Test your installation by running:

• which python3

You should see something like: /usr/local/bin/python3

Install git & download repo

Install git:

• brew install git

Clone the repo:

• git clone https://github.com/jakee417/Pico-Train-Switching.git

Installation

Installing the firmware and build files:

1. Run the installation script

   python3 install.py firmware/RPI_PICO_W-20231005-v1.21.0.uf2

Warning

Ensure your Raspberry Pi Pico W is the only connected usb device before completing the next step.

2. Connect your Raspberry Pi Pico W to a usb port in BOOTSEL mode

(back to top)

Usage

• Running the REST API is automatic, simply power on your Raspberry Pi Pico W to interact with the REST API.

• Running the REST API in dev mode from a MicroPython REPL:

  from bin.main import run; run()

For more examples, please refer to the Documentation

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Jake - @github_handle

Project Link: https://github.com/jakee417/Pico-Train-Switching

(back to top)