updated README and examples

Youda008 · Jun 19, 2021 · 4db405f · 4db405f
1 parent 275f30a
commit 4db405f
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -16,15 +16,16 @@ using orgb::RequestStatus;
 using orgb::DeviceType;
 ```
 
-Create the client and connect to OpenRGB server.
+Create the client and connect to an OpenRGB server.
 ```
 orgb::Client client( "My OpenRGB Client" );
 
 ConnectStatus status = client.connect( "127.0.0.1" );  // you can also use Windows computer name
 if (status != ConnectStatus::Success)
 {
-	fprintf( stderr, "failed to connect (error code: %d)\n", int( client.getLastSystemError() ) );
-	return;
+    fprintf( stderr, "failed to connect: %s (error code: %d)\n",
+        enumString( status ), int( client.getLastSystemError() ) );
+    return;
 }
 ```
 
@@ -33,8 +34,9 @@ Download a list of devices and their settings.
 DeviceListResult result = client.requestDeviceList();
 if (result.status != RequestStatus::Success)
 {
-	fprintf( stderr, "failed to get device list\n" );
-	return;
+    fprintf( stderr, "failed to get device list: %s (error code: %d)\n",
+        enumString( result.status ), int( client.getLastSystemError() ) );
+    return;
 }
 ```
 
@@ -43,8 +45,8 @@ Find the device you want to control. You can search by type or name.
 const Device * cpuCooler = result.devices.find( DeviceType::Cooler );
 if (!cpuCooler)
 {
-	fprintf( stderr, "device CPU cooler not found.\n" );
-	return;
+    fprintf( stderr, "device CPU cooler not found.\n" );
+    return;
 }
 ```
 
@@ -54,8 +56,8 @@ This is how you do it.
 const Mode * directMode = cpuCooler->findMode( "Direct" );
 if (!directMode)
 {
-	fprintf( stderr, "\"Direct\" mode not found in CPU cooler.\n" );
-	return;
+    fprintf( stderr, "\"Direct\" mode not found in CPU cooler.\n" );
+    return;
 }
 client.changeMode( *cpuCooler, *directMode );
 ```
@@ -69,6 +71,12 @@ You can create any color by using the `Color` constructor.
 ```
 Color customColor( 255, 128, 64 );
 ```
+It is also possible to create color from strings "black", "red", "cyan" and from hex notation in format "#1267AB" by using method `fromString`
+```
+Color color;
+if (!color.fromString( input ))
+    fprintf( stderr, "Invalid input.\n" );
+```
 
 #### !!WARNING!!
 Between any color or mode change requests there should be at least few millisecond delay. Current implementation of OpenRGB is unreliable and bugs itself when you send it multiple requests at once.
@@ -83,31 +91,31 @@ If you don't like the old-school way of checking return values, there are except
 ```
 try
 {
-	orgb::Client client( "My OpenRGB Client" );
+    orgb::Client client( "My OpenRGB Client" );
 
-	client.connectX( "127.0.0.1" );
+    client.connectX( "127.0.0.1" );
 
-	DeviceList devices = client.requestDeviceListX();
+    DeviceList devices = client.requestDeviceListX();
 
-	const Device & cpuCooler = devices.findX( DeviceType::Cooler );
+    const Device & cpuCooler = devices.findX( DeviceType::Cooler );
 
-	const Mode & directMode = cpuCooler->findModeX( "Direct" );
+    const Mode & directMode = cpuCooler->findModeX( "Direct" );
 
-	client.changeModeX( cpuCooler, directMode );
+    client.changeModeX( cpuCooler, directMode );
 
-	client.setDeviceColorX( cpuCooler, Color::RED );
+    client.setDeviceColorX( cpuCooler, Color::Red );
 }
 catch (const orgb::Exception & ex)
 {
-	printf( "Error: %s\n", ex.errorMessage() );
+    printf( "Error: %s\n", ex.errorMessage() );
 }
 ```
 
 #### More examples
 Complete examples of working apps using this library can be found in directory `examples`, feel free to copy&paste anything.
 
 #### Building your application
-Depending on your IDE or build system, you must add the directory `include` to your include directories and the directory where you built this library to your link library directories. Then you must link library `orgbsdk` to your app. The library is static, so you don't have to worry about moving any dynamic librariess around together with your app.
+Depending on your IDE or build system, you must add the directory `include` to your include directories and the directory where you built this library to your link library directories. Then you must link library `orgbsdk` to your app. The library is static, so you don't have to worry about moving any dynamic libraries around together with your app.
 
 Simpliest example with GCC
 ```
@@ -117,6 +125,13 @@ g++ -I"<path to OpenRGB-cppSDK>/include" -L"<path to OpenRGB-cppSDK>/build" -o m
 
 ## How to build the library
 
+First initialize all submodules, either with via any graphical tool or
+```
+git submodule update --init
+```
+Then proceed according to your OS and build chain.
+
+
 ### Windows - Msys2
 
 ```

diff --git a/examples/ContinuouslyUpdateColors.cpp b/examples/ContinuouslyUpdateColors.cpp
@@ -83,7 +83,7 @@ int main( int /*argc*/, char * /*argv*/ [] )
 			DeviceListResult result = client.requestDeviceList();
 			if (result.status != RequestStatus::Success)
 			{
-				printf( "failed to get device list (error code: %d)\n", int(client.getLastSystemError()) );
+				printf( "failed to get device list: %s (error code: %d)\n", enumString( result.status ), int( client.getLastSystemError() ) );
 				// reset everything and try again
 				client.disconnect();
 				continue;

diff --git a/examples/PrintDevices.cpp b/examples/PrintDevices.cpp
@@ -25,7 +25,7 @@ int main( int /*argc*/, char * /*argv*/ [] )
 	DeviceListResult result = client.requestDeviceList();
 	if (result.status != RequestStatus::Success)
 	{
-		fprintf( stderr, "failed to get device list\n" );
+		fprintf( stderr, "failed to get device list: %s (error code: %d)\n", enumString( result.status ), int( client.getLastSystemError() ) );
 		return 2;
 	}
 

diff --git a/examples/SetCPUCoolerToRed.cpp b/examples/SetCPUCoolerToRed.cpp
@@ -31,7 +31,7 @@ int main( int /*argc*/, char * /*argv*/ [] )
 	DeviceListResult result = client.requestDeviceList();
 	if (result.status != RequestStatus::Success)
 	{
-		fprintf( stderr, "failed to get device list\n" );
+		fprintf( stderr, "failed to get device list: %s (error code: %d)\n", enumString( status ), int( client.getLastSystemError() ) );
 		return 2;
 	}
 

diff --git a/src/test/main.cpp b/src/test/main.cpp
@@ -278,7 +278,7 @@ static bool list( const ArgList & )
 
 	if (listResult.status != RequestStatus::Success)
 	{
-		cout << " -> failed: " << enumString( listResult.status ) << endl;
+		cout << " -> failed: " << enumString( listResult.status ) << " (error code: " << client.getLastSystemError() << ")" << endl;
 		return false;
 	}