-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
87 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,6 @@ | ||
We only officialy support the Raspberry Pi 4 and 5, as well as derivatives of these such as the 400 or Compute Module 4. | ||
It is possible to use the older models+, but **it is not recommended or supported**. Should you choose to do so, you do so at your own risk and with the understanding that the community will not be able to help you with any issues. | ||
|
||
The Raspberry Pi 4 is the first Raspberry Pi SBC (single board computer) that is able to stably run the Companion software. The 4GB/8GB variants of the Raspberry Pi 4/400/5 are the only recommended options. As stated above, any Raspberry Pi SBC lower than the 4 is unsupported and is used at your own risk. | ||
|
||
If you are installing Companion from scratch on an older Pi 4, make sure you've got your system updated with the latest eeprom/firmware updates ([info here](https://www.raspberrypi.org/forums/viewtopic.php?t=255001)). A update (late October 2019) combines the update mechanisms for both the SPI EEPROM and the VLI USB controller chip. Installing the latest updates will (in the future) open up the ability to boot your Raspberry Pi from a network-connected device or from an external USB storage device, and also updates the VLI firmware to reduce power consumption and bring running temperatures down by up to 3-4 °C. | ||
|
||
|
||
Models older then the 4 are not supported as stability issues were identified which we believe are due to multiple (potentially interrelated) factors, including power output capability (e.g. to power a Stream Deck), power input requirements, OEM power supply capacity, Ethernet-no-longer-on-shared-USB-bus, maximum RAM, and of course CPU (as detailed in [Issue #313](https://github.com/bitfocus/companion/issues/313)). Accordingly, ongoing development efforts are focused on Raspberry Pi 4 systems. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
You can download the image from the [BitFocus website](https://user.bitfocus.io/download). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Once you've got your Raspberry Pi up and running with the CompanionPi image, you'll need to know the IP address of your Raspberry Pi. There are a few ways to do this: | ||
|
||
- A custom Python script written to email you the IP address every time it boots _(requires internet connection at boot)_: [on GitHub, here](https://github.com/oliverscheer/send-email-with-device-ip-address) | ||
- Set a static IP address on your Pi _(good option if your Raspberry Pi is going to be always connected to the same equipment)_: [this tutorial from The Pi Hut](https://thepihut.com/blogs/raspberry-pi-tutorials/how-to-give-your-raspberry-pi-a-static-ip-address-update) | ||
- An attached LCD display to show your current IP address _(a little maker-y, and pretty cool)_: [example from PiMyLifeUp](https://pimylifeup.com/raspberry-pi-lcd-16x2/) | ||
|
||
Once you know your IP address, you can access the Companion Admin User Interface on port 8000 of that IP address (i.e. http://192.168.1.3:8000). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
First of all, you're going to want a fast Micro SD card. One of the most popular ones currently on the market is the SanDisk Extreme PRO 32GB card ([on Amazon, here (Amazon US)](https://www.amazon.com/gp/product/B06XYHN68L)). This isn't always going to be _the best_ one to use, but it is a very good, adequately fast microSD card. Look for anything that is classified as UHS 1 or higher as these will have the read/write speeds you need for your Raspberry Pi to be useful instead of a slow pain in the neck. | ||
|
||
Once you've got your fast microSD card in hand, you'll need a tool for flashing the image to the card. One of the most popular tools is Balena Etcher (Windows, Mac, and Linux). It's very easy to use. You can [download it here](https://www.balena.io/etcher/). | ||
|
||
> On first boot, it'll take a few minutes for the Admin User Interface to be available. The OS has to resize itself to the capacity of your SD card and that takes an extra reboot. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,5 @@ | ||
Only users who are comfortable with Linux and debugging issues themselves should attempt this flow, we may not be able to help with any issues encountered unless it is something at fault with our tooling. | ||
|
||
This is supported on any x64 or ARM64 machine, and requires a debian or ubuntu based OS of a matching CPU architecture. | ||
|
||
We recommend using a headless or server install, as it maximises the resources available to Companion. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
The recommended way to install Companion is to run the following as root | ||
|
||
``` | ||
curl https://raw.githubusercontent.com/bitfocus/companion-pi/main/install.sh | bash | ||
``` | ||
|
||
This will perform the same installation and setup steps as the CompanionPi image. | ||
These steps include: | ||
* Create a `companion` user | ||
* Install any required system dependencies | ||
* Downloading the latest beta build of Companion | ||
* Setup udev rules to allow using Streamdecks and other supported surface | ||
* Setup sudo rules to allow Companion to shutdown and restart the system | ||
* Install scripts such as `companion-update` | ||
If you want to understand the full scope of the changes, you can read the [install script](https://github.com/bitfocus/companion-pi/blob/main/install.sh). | ||
|
||
You are free to customise the installation as you wish, but care should be taken to avoid breaking the updater or making changes that the updater will replace during the next update. | ||
If you need further customisation over this, let us know in [an issue](https://github.com/bitfocus/companion-pi/issues) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Before starting the installation process, you'll need to get your OS set up and configured. | ||
|
||
Now is a good opportunity to make sure the OS has the latest updates installed. |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
While it is no longer supported, you can downgrade your installation of v3 to v2.4.2. | ||
This process will take many minutes to run, as it has to compile Companion from the source. | ||
|
||
* `sudo git clone https://github.com/bitfocus/companion.git -b stable-2.4 stable-2.4 /usr/local/src/companion` | ||
* `sudo companion-update` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
If your CompanionPi install was made with the install script, or using an image of 2.2.0 or later, you can use the updater to easily update to the latest version. | ||
|
||
If you have a CompanionPi install that was made before the 2.2.0 CompanionPi image, it is recommended that you backup your config and reimport it into a fresh installation. | ||
|
||
A lot has changed in the 2.2.0 builds, including an overhaul of the CompanionPi images. The major change is the ability for CompanionPi to manage various dependencies itself, allowing updates after that version to be done in a seamless manner. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Once you SSH or login to the machine running Companion, you can run `sudo companion-update` to launch the interactive updater to select and install a diferent version of Companion. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters