Working on tests etc.

Author: malotte

README.md

@@ -3,9 +3,53 @@
 #The uart application#
 
 
-##Modules##
+
+### Interface description ###
 
 
 <table width="100%" border="0" summary="list of modules">
 <tr><td><a href="http://github.com/tonyrog/uart/blob/master/doc/uart.md" class="module">uart</a></td></tr></table>
 
+### Dependencies ###
+
+To build uart you will need a working installation of Erlang R15B (or
+later).<br/>
+Information on building and installing [Erlang/OTP](http://www.erlang.org)
+can be found [here](https://github.com/erlang/otp/wiki/Installation)
+([more info](https://github.com/erlang/otp/blob/master/INSTALL.md)).
+
+uart is built using rebar that can be found [here](https://github.com/basho/rebar), with building instructions [here](https://github.com/basho/rebar/wiki/Building-rebar).
+
+uart also requires the following applications to be installed:
+<ul>
+<li>dtread - https://github.com/tonyrog/dtread</li>
+</ul>
+
+### Downloading
+
+Clone the repository in a suitable location:
+
+```sh
+$ git clone git://github.com/tonyrog/uart.git
+```
+### Configurating
+#### Concepts
+
+...
+
+#### Files
+
+...
+
+### Building
+
+Compile:
+
+```sh
+$ cd uart
+$ rebar compile
+...
+==> uart (compile)
+```
+
+

rebar.config

@@ -38,3 +38,5 @@
               {"./README.md",
                "http://github.com/tonyrog/uart"}}]}.
 
+{ct_extra_params, " -ct_config test/uart.cfg"}.
+

src/uart.erl

@@ -469,7 +469,8 @@ recv_(Uart, Length, Timeout) when
 		{'EXIT', Uart, _Reason} ->
 		    {error, closed}
 	    end;
-	Error -> Error
+	Error -> 
+	    Error
     end.
 
 %%--------------------------------------------------------------------

test/uart_test.cfg renamed to test/uart.cfg

@@ -2,8 +2,9 @@
 %% Configuration file for testing of uart
 %%
 
-%% Drivers
-{driver, [{darwin, [{a, "/dev/tty.usbserial-FTF5DP2J"},
+%% Devices
+%% Must be adapted !!! Find devicename in System Profile
+{device, [{darwin, [{a, "/dev/tty.usbserial-FTF5DP2J"},
 		    {b, "/dev/tty.usbserial-FTFBXORB"}]},
 	  {linux, [{a, "/dev/ttyUSB0"},
 		   {b, "/dev/ttyUSB1"}]},

test/uart_SUITE.erl

@@ -43,7 +43,7 @@
 %%--------------------------------------------------------------------
 suite() ->
     [{timetrap,{minutes,10}},
-     {require, driver}].
+     {require, device}].
 
 
 %%--------------------------------------------------------------------
@@ -301,25 +301,25 @@ tty(a) ->
     case os:type() of
 	{unix,darwin} ->
 	    %% "/dev/tty.usbserial-FTF5DP2J";
-	    ct:get_config({driver, darwin, a});
+	    ct:get_config({device, darwin, a});
 	{unix,linux} ->
 	    %% "/dev/ttyUSB0";
-	    ct:get_config({driver, linux, a});
+	    ct:get_config({device, linux, a});
 	{win32,_} ->
 	    %% "COM10"
-	    ct:get_config({driver, win32, a})
+	    ct:get_config({device, win32, a})
     end;
 tty(b) ->
     case os:type() of
 	{unix,darwin} ->
 	    %% "/dev/tty.usbserial-FTFBXORB";
-	    ct:get_config({driver, darwin, b});
+	    ct:get_config({device, darwin, b});
 	{unix,linux} ->
 	    %% "/dev/ttyUSB1";
-	    ct:get_config({driver, linux, b});
+	    ct:get_config({device, linux, b});
 	{win32,_} ->
 	    %% "COM11"
-	    ct:get_config({driver, win32, b})
+	    ct:get_config({device, win32, b})
     end;
 tty(pty) ->
     "pty";