Textimo is a software solution designed to stream live lyrics to a video projector without a laptop, by simply connecting a Raspberry Pi to the video projector. The Raspberry is configured to be plug and play: you just have to power up the Raspberry and connect the HDMI cable to the video projector. Then you have to connect the mobile app to Raspberry's WiFi hotspot and stream or add lyrics.
From the Textimo Mobile App, you can control and customize the live stream: what song's verse to show or how the Live Page should look (background color, font size, etc.)
Sequence.01.mp4
Textimo uses two services:
-
Textimo Backend Server: it's a NodeJS App that runs in the background on the Raspberry Pi and a Full Screen Sandbox Chromium Window that is displayed on the external screen via HDMI (projector or display) on startup. Raspberry Pi runs the light versions (without desktop) edition of Raspbian (Stretch), and uses Xorg display manager to display only the Chromium window.
-
Textimo Mobile App: a Flutter app that uses Textimo Server REST API to control everything. The app connects to the Raspberry PI using the WiFi hotspot created by the Raspberry itself.
- Budget solution for a chorus that needs to display some live lyrics using a standalone system
- You can costumize the LivePage from the app
- You can add songs and lyrics using camera (OCR)
- You can control what verse is being shown on the LivePage
- Swagger REST API documentation at /api-docs route
- Download Raspberry Pi OS Lite: https://www.raspberrypi.com/software/operating-systems/. The desktop version works as well, but the Lite version offers a faster boot time.
- Install Node 16, NPM, PM2, Chromium and X11/Xinit X window manager
- Setup Raspberry to create a WiFi hotspot and make sure that the IP Address of the Raspberry is always 172.24.1.1. If you want to change the IP Address you have to update start.sh, textimo_backend/config/config.js, textimo_mobile_app/lib/config/config.dart (and the rebuild the flutter app)
- Download the latest Textimo Backend Release or clone the main github branch
- Unarchive the .zip file and move the textimo_backend folder to the home folder of pi user
- Start the Node app with PM2 and save it to open on startup
- In the home folder, add the following .sh files:
mainstart.sh
#!/bin/bash
startx ./start.sh
start.sh
#!/bin/sh
xset -dpms
xset s off
xset s noblank
unclutter &
chromium-browser http://172.24.1.1:3000/LivePage --window-size=1920,1080 --start-fullscreen --kiosk --incognito --noerrdialogs --disable-translate --no-first-run --fast --fast-start --disable-infobars --disable-features=TranslateUI --disk-cache-dir=/dev/null
- Add executable permission to these files and create a cronjob to run on startup mainstart.sh
- Install textimo_mobile_app on your phone (the app is only available in Romanian language, no English support for now): https://github.com/PavelProdan/textimo_mobile_app
Regardless of whether you develop locally or directly in production, the full App is available on the main branch and uses port 3000. The REST API documenation is available at "/api-docs" route using Swagger. The page that contains the livestream is available at "/LivePage".
Important! Don't delete the files from the "database" folder. You can remove the content using the API routes.
In index.js you can find the main NodeJS App. The project uses a simple route-service schema. All routes are available in the "routes" folder and in the "services" folder you can find the backend process that interacts with the database.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the Label "Feature request". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GNU GPLv3 License. See LICENSE.txt for more information.
Created with ❤️ by Pavel Prodan in 2022