updated readme file with osc server info
This commit is contained in:
		
							parent
							
								
									96c6012d4e
								
							
						
					
					
						commit
						19709d9db7
					
				
							
								
								
									
										24
									
								
								README.md
								
								
								
								
							
							
						
						
									
										24
									
								
								README.md
								
								
								
								
							| 
						 | 
					@ -1,4 +1,4 @@
 | 
				
			||||||
# puredata
 | 
					# puredata class
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This repo contains a short puredata class with some examples and a webserver.
 | 
					This repo contains a short puredata class with some examples and a webserver.
 | 
				
			||||||
Use pandoc to generate the index.html in the source directory.
 | 
					Use pandoc to generate the index.html in the source directory.
 | 
				
			||||||
| 
						 | 
					@ -9,6 +9,28 @@ Dependencies:
 | 
				
			||||||
* pandoc
 | 
					* pandoc
 | 
				
			||||||
* python3 bottle framework
 | 
					* python3 bottle framework
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					It also includes a small OSC server that can be used to dispatch data to clients.
 | 
				
			||||||
 | 
					This server fetches JSON data from online sources and formats it to OSC bundles.
 | 
				
			||||||
 | 
					It currently dispatches:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					* weather data
 | 
				
			||||||
 | 
					* bitcoin price data
 | 
				
			||||||
 | 
					* cpu and ram data
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To run the server you need these python3 dependencies that can be installed with pip.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					* python-osc
 | 
				
			||||||
 | 
					* psutil
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					The server **listens** on port **8080** and send OSC data back on port **8081** to the client who requested the data.
 | 
				
			||||||
 | 
					The following OSC messages can be sent to the server.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```python
 | 
				
			||||||
 | 
					/get/weather [CITY]
 | 
				
			||||||
 | 
					/get/bitcoin
 | 
				
			||||||
 | 
					/get/cpu
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# todo
 | 
					# todo
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* have each chapter be more verbose
 | 
					* have each chapter be more verbose
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue