f1_bot v0.7.0

View Source Race Bot

Docs License Twitter

An Elixir project dedicated to processing live data from Formula 1 races.

Project's Website displays live telemetry and analysis (Work in progress).

Development & Demo Website displays telemetry of previous events to demonstate the functionality.

Documentation

All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

requirements

 Requirements

Alternatively you can use asdf to manage tool versions, but be aware that it builds Erlang from source which requires installation of additional system dependencies.

basic-usage

 Basic usage 

# Install dependencies
mix setup

# Configuration file `.env` must be created by copying `.env.example`
cp .env.example .env

# Copy .env into your environment variables - the application doesn't read .env file on its own 
# Only works on fish terminal at the moment
source env.fish

# Generate documentation
mix docs

# Run locally
iex -S mix phx.server

# Run a backtest on an old session
iex -S mix backtest --url "http://livetiming.formula1.com/static/2022/2022-05-08_Miami_Grand_Prix/2022-05-07_Qualifying"

intro

 Intro

To get a general overview of the data flow and processing in this project, you can explore the project in this order:

Example packet: SessionStatus packet with status started

  1. F1Bot.ExternalApi.SignalR.Client receives the packet from live timing API
  2. F1Bot.F1Session.Server calls the functional code to process this Packet
  3. F1Bot.F1Session.LiveTimingHandlers determines and calls the handler module for this packet
  4. F1Bot.F1Session.LiveTimingHandlers.SessionStatus calls F1Session function to update the state
  5. F1Bot.F1Session updates its state with new session status and returns its new state + a 'session status change' event
  6. F1Bot.F1Session.Server broadcasts the event via F1Bot.PubSub
  7. F1Bot.Output.Discord receives the session status change event and composes a Discord message
  8. F1Bot.ExternalApi.Discord chooses the configured Discord client module (live or console for local testing)
  9. F1Bot.ExternalApi.Discord.Console outputs composed message ("F1 Session just started") to your console

contributing

 Contributing

Pull requests, bug reports and feature suggestions are welcome!

thanks

 Thanks

💙 theOehrly/Fast-F1: For inspiration, their effort and documentation. Fast-F1 was extremely valuable in quickly understanding how F1's live timing service works.

💙 MultiViewer for F1: For tyre icons used in this project

license

 License

This project is licensed under GNU Affero General Public License version 3, see LICENSE.md for details.