Skip to content

Commit

Permalink
Merge branch 'master' of github.com:Novakasa/brickrail
Browse files Browse the repository at this point in the history
  • Loading branch information
Novakasa committed Aug 2, 2024
2 parents 94718fb + a348562 commit bc1901c
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Brickrail
Work in progress LEGO train automation software for PoweredUp
Train automation software for the LEGO PoweredUp ecosystem

![anim](images/readme-anim.gif)

Expand All @@ -16,9 +16,17 @@ Head to the [Wiki](https://github.com/Novakasa/brickrail/wiki) to learn more!

![GUI screenshot](images/screenshot3.PNG)

## LEGO Hub compatibility

The most well-tested hubs currently are the LEGO City hub (That usually come with LEGO City train sets) and the LEGO Technic (Control+) hub. The Mindstorms (Spike Prime) hub should also work by default, but is not tested as regularly. Unfortunately, the move hub (from LEGO Boost) is currently incompatible because of it's low memory.

## Limitations

Since the project relies on Bluetooth for communication between PC and all hubs, there is a practical limitation to how many hubs can be connected simultaneously. This limit seems to be around 7-8 simultaneous connections for a Windows PC, but your mileage may vary depending on the OS and the bluetooth adapter used. Keep that in mind when planning your layout!

## Current state

Brickrail currently is in alpha stage. Users have reported succesfully automating their layouts, but each setup is a bit different and fixes are done in response to reports all the time. More reports are needed to confidently move to a stable release. If you are willing to give Brickrail a go, feel free to share your issues over in [discussions](https://github.com/Novakasa/brickrail/discussions). Reports of success are also greatly appreciated, as well as any usability/quality-of-life improvement requests.
Users have reported succesfully automating their layouts, but each setup is a bit different. If you are willing to give Brickrail a go, feel free to share your issues over in [discussions](https://github.com/Novakasa/brickrail/discussions). Reports of success are also greatly appreciated, as well as any usability/quality-of-life improvement requests.

## Links

Expand Down

0 comments on commit bc1901c

Please sign in to comment.