Setup documentation
This commit is contained in:
		
							
								
								
									
										42
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										42
									
								
								README.md
									
									
									
									
									
								
							@@ -3,7 +3,9 @@
 | 
			
		||||
A custom DMX server that integrates with [Home Assistant](https://home-assistant.io).
 | 
			
		||||
 | 
			
		||||
## Setup
 | 
			
		||||
To setup AquaDMX run through the following to install the python dependencies and configure the integration with Home Assistant.
 | 
			
		||||
 | 
			
		||||
### Install
 | 
			
		||||
```sh
 | 
			
		||||
pip install -r requirements.txt
 | 
			
		||||
```
 | 
			
		||||
@@ -17,3 +19,43 @@ token=
 | 
			
		||||
 | 
			
		||||
url is the address of the Home Assistant instance with http or https.
 | 
			
		||||
token is the Long-Lived Access Token for Home Assistant. It can be obtained by going to the Home Assistant profile page and scrolling to the Long-Lived Access Tokens section and click Create Token. Give the token a name and click OK. Copy the token.
 | 
			
		||||
 | 
			
		||||
### Lights
 | 
			
		||||
To add lights add them to the `settings.ini` config file under by creating a Light section like the follow.
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
[Lights]
 | 
			
		||||
dimmer=light.dimmer_1
 | 
			
		||||
       light.dimmer_2
 | 
			
		||||
rgb=light.rgb_1
 | 
			
		||||
    light.rgb_2
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
#### Supported Light Types
 | 
			
		||||
 | 
			
		||||
##### Dimmer
 | 
			
		||||
Dimmer lights use a single DMX channel and will set the light brightness according to the channel value.
 | 
			
		||||
 | 
			
		||||
| Channel | Setting    |
 | 
			
		||||
|---------|------------|
 | 
			
		||||
| 1       | Brightness |
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
##### RGB
 | 
			
		||||
RGB lights use four DMX channels to set brightness and RGB values.
 | 
			
		||||
 | 
			
		||||
| Channel | Setting    |
 | 
			
		||||
|---------|------------|
 | 
			
		||||
| 1       | Brightness |
 | 
			
		||||
| 2       | Red        |
 | 
			
		||||
| 3       | Green      |
 | 
			
		||||
| 4       | Blue       |
 | 
			
		||||
 | 
			
		||||
### Running
 | 
			
		||||
 | 
			
		||||
To run the program run the following command:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
python aquadmx.py
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user