> For the complete documentation index, see [llms.txt](https://craftbeerpi.gitbook.io/craftbeerpi4/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://craftbeerpi.gitbook.io/craftbeerpi4/master.md).
# CraftBeerPi
## Intro
CraftBeerPi is an open source brewing controller.
## Installation
CraftBeerPi is python based and will require at last python 3.7.x\
You can run CBPi 4.x on your Laptop. It's not required to use a Raspberry Pi.
Download an install Python 3.7
Open a terminal window and run the following commands.
#### Install from PyPi - Recommanded for Raspberry Pi
```
sudo pip install cbpi
```
**Install from GitHub - Developer Version for Plugin Development**
```
sudo pip install https://github.com/Manuel83/craftbeerpi4/archive/master.zip
```
#### Setup Environment
```bash
cbpi setup
```
The setup command will create a config folder in directory where you executed this command. The config folder contains all instance data. For example all your hardware configuration and log files.
{% hint style="info" %}
You can setup as many enviroments as you like on one computer / Raspberry pi.\
Just navigate to a diffent folder and run the setup command again. This will create additional config folder
{% endhint %}
#### Run the Server
```
cbpi start
```
The server is running under by default.
#### Access the User Interface
```
http://:8000/
```
{% hint style="info" %}
Port 8000 is the default port. You can change this port in the config folder config.yaml
{% endhint %}
### Create a Python Virtual Environment
The advantage of a virtual enviroment is to separate the python dependencies.\
This is interesting for testing and to install several CBPi intances at the same time.
{% embed url="" %}
```
python3 -m venv venv
source venv/bin/activate
```
## Uninstall
```
pip uninstall cbpi
```
## List installed packaged
```
pip list
```
## Setup 1Wire (DS18B20) on Raspberry Pi
CraftBeerPi is supporting digital temperature sensors like DS18B20 via 1Wire protocol\
On a Raspberry Pi it's required to add some configuration that 1Wire is working.
The following command will add the file `/boot/config.txt` to your Raspberry Pi. The content of the file is: `dtoverlay=w1-gpio,gpiopin=4,pullup=on`
```
sudo cbpi onewire --setup
```
The follwowing commad will list all onewire devices on your system
```
sudo cbpi onewire --list
```
### Alternative - Activate 1Wire via Raspi-Config
You can activate 1Wire also via Raspi-Config
```
sudo raspi-config
```
## Links
{% embed url="" %}
{% embed url="" %}
{% embed url="" %}