README updated

Author: uncleeugene

README.md

@@ -1,25 +1,28 @@
 sACN to DMX converter
 =====================
 
+### version 0.2
+
+
 This little command-line tool provides an interface between sACN network and DMX hardware. Basically it feeds your DMX dongle with whatever comes from sACN receiver.
 
 At the moment being there are two supported types of interfaces:
-1. Enttec Open DMX. It is widely known as one of the cheapest DMX dongles on the market. Many clones of this device have been manufactured around the world thanks to its simplicity and openness. Basically, a variety of cheap USB-RS485 converters off aliexpress will work just as good as original device (as soon as it is a FTDI chip based device). You can even make one yourself if you know which side of soldering iron is safe to touch :) I will not provide instructions though. Google it.
+1. Enttec Open DMX. It is widely known as one of the cheapest DMX dongles on the market. Many clones of this device have been manufactured around the world thanks to its simplicity and openness. Basically, a variety of cheap USB-RS485 converters off aliexpress will work just as good as original device (as soon as it is an FTDI chip based device). You can even make one yourself if you know which side of soldering iron is safe to touch :) I will not provide instructions though. Google it.
 
-2. Generic UART interface. As soon as your UART (COM-port) interface can run at 250kbit it can be used (in theory) to feed DMX data to fixtures. Not all built-in UARTs are able to run that fast, but it's not a good idea to wire your motherboard directly to your lights anyway. Yet i tested this approach on FT232 VCP mode, CH340/341 USB-UART chips and built-in UART on Raspberry Pi and it works. So if previous option is not for you, you can test this one. It is supposed to work with pretty much any USB-RS485 interface. No warranties provided though, i only tested it on what i have on hand.
+2. Generic UART interface. As soon as your UART (COM-port) interface can run at 250kbit it can be used (in theory) to feed DMX data to fixtures. Not all built-in UARTs are able to run that fast, but it's not a good idea to wire your motherboard directly to your light fixtures anyways. Yet i tested this approach on FT232 VCP mode, CH340/341 USB-UART chips and even built-in UART on Raspberry Pi and it works. So if previous option is not for you, you can test this one. It is supposed to work with pretty much any USB-RS485 interface. No warranties provided though, i only tested it on what i have on hand.
 
 How to use
 ----------
 
-This is a command-line tool, so you run this in terminal. If you're a linux user you need no explaination. If you run Windows search for "command line" or "power shell" in your Start menu.
+This is a command-line tool, so you run this in terminal. If you're a linux user you probably need no further explaination. If you run Windows, search for "command line" or "power shell" in your Start menu.
 
-First you want to find out what hardware devices are available in your system. You may run the tool with `-t <device type> -l` options:
+First you want to find out what hardware devices are available on your system. You may run the tool with `-t <device type> -l` options:
 
 	d:\sacndmx\sacndmx.exe -t uart -l
 	Port 0: COM1
 	Port 1: COM6
 
-Now you see what devices are available. There are two possible variants of '-t': uart and opendmx. Latter is default if no `-t` option provided.
+Now you see all available devices. There are two possible variants of `-t`: `uart` and `opendmx`. Latter is default.
 
 Also you may want to know what ip-addresses you can bind to. Check possible adresses with `-n` option:
 
@@ -32,21 +35,21 @@ Now let's say you want to run the tool on COM6 and bind to 192.168.1.101. Provid
 
 	D:\sacndmx>sacndmx.exe -t uart -d COM6 -s 192.168.1.101
 	sACN-DMX is starting...
-	Using general UART (COM6)
-	sACN listener started on 192.168.1.101.
-	DMX stream started on general UART (COM6)
+	Using generic UART (COM6)
+	sACN listener started on 192.168.1.101
+	DMX stream started on generic UART (COM6)
 
-In most cases you will need to provide an ip address option. By default the tool will stick itself to 'localhost' address, which means that it will only listen to a machine it is running on.
+In most cases you will need to provide an ip-address option. By default the tool will stick itself to 'localhost' address, which means that it will only listen to a machine it is running on.
 
 On linux, you use your tty device path instaed of port name:
 
 	lightmaster@pi ~/sacndmx> ./sacndmx -t uart -d /dev/ttyAMA0 -s 192.168.1.90
 	sACN-DMX is starting...
-	Using general UART (/dev/ttyAMA0)
-	sACN listener started on 192.168.1.90.
-	DMX stream started on general UART (/dev/ttyAMA0)
+	Using generic UART (/dev/ttyAMA0)
+	sACN listener started on 192.168.1.90
+	DMX stream started on generic UART (/dev/ttyAMA0)
 
-And finally, if you want to run Enttec OpenDMX'ish device, you can let the `-t` option go and you can pick a particular device by its serial number:
+And finally, if you want to run Enttec OpenDMX'ish device, you can let the `-t` option go:
 
 	lightmaster@pi ~/sacndmx> ./sacndmx -l
     Device 0: Uncle Eugene's DMX Dongle A (S/N A5069FNKA)
@@ -62,10 +65,12 @@ And finally, if you want to run Enttec OpenDMX'ish device, you can let the `-t`
 
 All this is just the same way on Windows. You can of course get full list of possible options with usual `-h` key.
 
+Sidenote: on linux you could get four `opendmx` devices for one actual hardware unit. Most likely you need the first one, so you can omit `-d` option. Not sure why it works this way. But if you need to pick another one you still can use `-d`, i.e. `-d A5069FNKA`.
+
 Not yet here
 ------------
 
-There are couple of things not yet implemented but planned.
+There are couple of things not yet implemented but planned:
 1. incoming Art-Net support. Must be an easy one, there are libraries :)
 2. More hardware types. uDMX and enttecPro to begin with.
 3. Automatic hardware reconnect. Doable, but will take some effort to implement properly. Right now it will just fail if hardware connection is lost.

hardware/generalUART.go

@@ -50,7 +50,7 @@ func (d *UART) GetSerial() string {
 }
 
 func (d *UART) GetDescription() string {
-	return "general UART"
+	return "generic UART"
 }
 
 func (d *UART) SelectDevice(name string) error {

sacndmx.go

@@ -101,7 +101,7 @@ func main() {
 		}
 	})
 	recv.Start()
-	fmt.Printf("sACN listener started on %s.\n", CLIOptions.IPAddr)
+	fmt.Printf("sACN listener started on %s\n", CLIOptions.IPAddr)
 
 	go dmx.Run()
 	fmt.Printf("DMX stream started on %s (%s)\n", dmx.GetDescription(), dmx.GetSerial())