Development/Tutorials/Solid/Introduction - Revision history

Ervin at 14:41, 30 September 2011

2011-09-30T14:41:06Z

Ervin: moved Development/Tutorials/Solid Tutorials to Development/Tutorials/Solid/Introduction: Makes it more friendly to link and navigation

2011-09-30T13:27:52Z

moved Development/Tutorials/Solid Tutorials to Development/Tutorials/Solid/Introduction: Makes it more friendly to link and navigation

Neverendingo: Text replace - "" to ""

2011-06-29T20:56:34Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:46:05Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:46, 29 June 2011
			
Line 78:
Line 78:
  Listing udi for all installed devices:   Listing udi for all installed devices:
    
− <code> + <syntaxhighlight lang="text">
  solid-hardware list   solid-hardware list
  </code>   </code>
Line 84:
Line 84:
  Listing full details for all installed devices:   Listing full details for all installed devices:
    
− <code> + <syntaxhighlight lang="text">
  solid-hardware list details   solid-hardware list details
  </code>   </code>
Line 90:
Line 90:
  Listing all audio hardware devices:   Listing all audio hardware devices:
    
− <code> + <syntaxhighlight lang="text">
  solid-hardware query 'IS AudioInterface'   solid-hardware query 'IS AudioInterface'
  </code>   </code>



Neverendingo: Text replace - "" to ""

2011-06-29T20:30:52Z
Text replace - "<code cppqt>" to "<syntaxhighlight lang="cpp-qt">"

				
				
				
				
			
			← Older revision
			Revision as of 20:30, 29 June 2011
			
Line 13:
Line 13:
  Our first program will be a simple console based app that gets a list of all the hardware devices and prints them out to the screen.   Our first program will be a simple console based app that gets a list of all the hardware devices and prints them out to the screen.
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
       Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();        Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
  </code>   </code>
Line 19:
Line 19:
  This gets us the device manager.  All the devices are queried through and returned from the device manager.  Once we have the list of devices we can interact with them as follows:   This gets us the device manager.  All the devices are queried through and returned from the device manager.  Once we have the list of devices we can interact with them as follows:
    
− <code cppqt>foreach( Solid::Device device, Solid::Device::allDevices() ) + <syntaxhighlight lang="cpp-qt">foreach( Solid::Device device, Solid::Device::allDevices() )
  {   {
       //print the name of device        //print the name of device
Line 33:
Line 33:
  This second program makes uses of filters built into the solid framework.  Using these filters you can list only devices according to supported capabilities, sub-devices of a given parent, and various predicates.  In our example we'll be limiting our list to only audio hardware.  A full list of capabilities can be viewed under the Solid::Capability namespace.   This second program makes uses of filters built into the solid framework.  Using these filters you can list only devices according to supported capabilities, sub-devices of a given parent, and various predicates.  In our example we'll be limiting our list to only audio hardware.  A full list of capabilities can be viewed under the Solid::Capability namespace.
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();   Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
                 
Line 45:
Line 45:
  In this example Solid::DeviceManager::findDevicesFromQuery looks for a device with any parent and the Solid::Capability::AudioHw capability.  If we had wanted to specify an AudioHw device with the parent "real_specific_parent" it would look like this:   In this example Solid::DeviceManager::findDevicesFromQuery looks for a device with any parent and the Solid::Capability::AudioHw capability.  If we had wanted to specify an AudioHw device with the parent "real_specific_parent" it would look like this:
                 
− <code cppqt>Solid::Device::listFromType(Solid::Capability::AudioHw,"real_specific_parent" )</code> + <syntaxhighlight lang="cpp-qt">Solid::Device::listFromType(Solid::Capability::AudioHw,"real_specific_parent" )</code>
  The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial2/ kdeexamples/solid/tutorial2/]".   The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial2/ kdeexamples/solid/tutorial2/]".
    
  == What do we do with a device once we get it? ==   == What do we do with a device once we get it? ==
  Now that we got a device, what do we do with it?  First let's look at the relationship between the Solid::Device and Solid::Capability. A Solid::Device can contain many Solid::Capability.  A device can be tested to have a capability in the following way:   Now that we got a device, what do we do with it?  First let's look at the relationship between the Solid::Device and Solid::Capability. A Solid::Device can contain many Solid::Capability.  A device can be tested to have a capability in the following way:
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
  Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();   Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
    
Line 67:
Line 67:
    
  To actually use this device as a processor we need to do the following:   To actually use this device as a processor we need to do the following:
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
       Solid::Processor *processor = device.as<Solid::Processor>();        Solid::Processor *processor = device.as<Solid::Processor>();
  </code>   </code>



Agateau: Documented solid-hardware
2009-12-28T17:02:03Z
Documented solid-hardware

				
				
				
				
			
			← Older revision
			Revision as of 17:02, 28 December 2009
			
Line 71:
Line 71:
  </code>   </code>
  The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial3/ kdeexamples/solid/tutorial3/]".   The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial3/ kdeexamples/solid/tutorial3/]".
  + 
  + == solid-hardware tool ==
  + 
  + kdebase-runtime provides solid-hardware, a command line tool to investigate available devices.
  + 
  + Listing udi for all installed devices:
  + 
  + <code>
  + solid-hardware list
  + </code>
  + 
  + Listing full details for all installed devices:
  + 
  + <code>
  + solid-hardware list details
  + </code>
  + 
  + Listing all audio hardware devices:
  + 
  + <code>
  + solid-hardware query 'IS AudioInterface'
  + </code>
    
  [[Category:Tutorial]]   [[Category:Tutorial]]



Frinring: moved to kdeexamples
2009-10-18T23:27:09Z
moved to kdeexamples

				
				
				
				
			
			← Older revision
			Revision as of 23:27, 18 October 2009
			
Line 46:
Line 46:
                 
  <code cppqt>Solid::Device::listFromType(Solid::Capability::AudioHw,"real_specific_parent" )</code>   <code cppqt>Solid::Device::listFromType(Solid::Capability::AudioHw,"real_specific_parent" )</code>
− The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdelibs/solid/examples/tutorial2/ kdelibs/solid/examples/tutorial2/]". + The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial2/ kdeexamples/solid/tutorial2/]".
    
  == What do we do with a device once we get it? ==   == What do we do with a device once we get it? ==
Line 70:
Line 70:
       Solid::Processor *processor = device.as<Solid::Processor>();        Solid::Processor *processor = device.as<Solid::Processor>();
  </code>   </code>
− The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdelibs/solid/examples/tutorial3/ kdelibs/solid/examples/tutorial3/]". + The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial3/ kdeexamples/solid/tutorial3/]".
    
  [[Category:Tutorial]]   [[Category:Tutorial]]



Frinring: moved to kdeexamples
2009-10-18T23:26:09Z
moved to kdeexamples

				
				
				
				
			
			← Older revision
			Revision as of 23:26, 18 October 2009
			
Line 28:
Line 28:
  device.udi() returns the Unique Device Identifier for the device as a QString. Even if you have more than one identical device, the UDI is guaranteed to be unique.  For example if you have a MythTV box with two PVR-250 T.V. capture cards in it, you will be able to refer to card #1 and #2 by their respective UDI.   device.udi() returns the Unique Device Identifier for the device as a QString. Even if you have more than one identical device, the UDI is guaranteed to be unique.  For example if you have a MythTV box with two PVR-250 T.V. capture cards in it, you will be able to refer to card #1 and #2 by their respective UDI.
    
− The complete program along with the CMake files necessary to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdelibs/solid/examples/tutorial1/ kdelibs/solid/examples/tutorial1/]". + The complete program along with the CMake files necessary to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial1/ kdeexamples/solid/tutorial1/]".
    
  == Searching for specific devices ==   == Searching for specific devices ==





EmanueleT at 14:54, 5 February 2008
2008-02-05T14:54:09Z


				
				
				
				
			
			← Older revision
			Revision as of 14:54, 5 February 2008
			
Line 2:
Line 2:
  Solid is the new hardware device framework for KDE 4 that features, among other things, a hardware discovery layer which allows you to detect and use devices regardless of operating system or architecture. You can learn more about the Solid project at [http://solid.kde.org solid.kde.org].   Solid is the new hardware device framework for KDE 4 that features, among other things, a hardware discovery layer which allows you to detect and use devices regardless of operating system or architecture. You can learn more about the Solid project at [http://solid.kde.org solid.kde.org].
    
− For a more detailed (still not complete!) description, read [[What's Solid|here]]. + For a more detailed (still not complete!) description, read [[Development/Architecture/KDE4/Solid|here]].
    
  == Who is this tutorial for? ==   == Who is this tutorial for? ==



Tampakrap: Add a reference
2008-02-05T14:46:13Z
Add a reference

				
				
				
				
			
			← Older revision
			Revision as of 14:46, 5 February 2008
			
Line 1:
Line 1:
  == What is Solid ==   == What is Solid ==
  Solid is the new hardware device framework for KDE 4 that features, among other things, a hardware discovery layer which allows you to detect and use devices regardless of operating system or architecture. You can learn more about the Solid project at [http://solid.kde.org solid.kde.org].   Solid is the new hardware device framework for KDE 4 that features, among other things, a hardware discovery layer which allows you to detect and use devices regardless of operating system or architecture. You can learn more about the Solid project at [http://solid.kde.org solid.kde.org].
  + 
  + For a more detailed (still not complete!) description, read [[What's Solid|here]].
    
  == Who is this tutorial for? ==   == Who is this tutorial for? ==

@@ Line 4: / Line 4: @@
 For a more detailed (still not complete!) description, read [[Development/Architecture/KDE4/Solid|here]].
-== Who is this tutorial for? ==
+== Who are those tutorials for? ==
 This tutorial is written for developers looking to use the Solid hardware discovery layer within their applications.  It can also serve as a good starting point for developers looking to start working on the Solid framework.
-== Prerequisites ==
+== Solid core library tutorials ==
-* A working KDE4 development environment. Documentation on setting up a KDE environment can be found [[Getting_Started|here]].
-== Listing Devices ==
+;[[Development/Tutorials/Solid/Device_Discovery|Listing Devices]]
-Our first program will be a simple console based app that gets a list of all the hardware devices and prints them out to the screen.
+:''How to use the Solid core library to discover the hardware and interact with the system.''
-<syntaxhighlight lang="cpp-qt">
+;[[Development/Tutorials/Solid/Network_Management|Accessing Network Information]]
-    Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
+:''How to use the Solid system to get information about the network''
-</syntaxhighlight>
-This gets us the device manager.  All the devices are queried through and returned from the device manager.  Once we have the list of devices we can interact with them as follows:
+;[[Development/Tutorials/Solid/Device_Actions|Creating a Device Action]]
+:''When your application is interested in registering actions with the system for removable hardware''
-<syntaxhighlight lang="cpp-qt">foreach( Solid::Device device, Solid::Device::allDevices() )
-−
-    //print the name of device
-    kDebug() << device.udi();
-−
-</syntaxhighlight>
-−
-device.udi() returns the Unique Device Identifier for the device as a QString. Even if you have more than one identical device, the UDI is guaranteed to be unique.  For example if you have a MythTV box with two PVR-250 T.V. capture cards in it, you will be able to refer to card #1 and #2 by their respective UDI.
-−
-The complete program along with the CMake files necessary to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial1/ kdeexamples/solid/tutorial1/]".
-−
-== Searching for specific devices ==
-This second program makes uses of filters built into the solid framework.  Using these filters you can list only devices according to supported capabilities, sub-devices of a given parent, and various predicates.  In our example we'll be limiting our list to only audio hardware.  A full list of capabilities can be viewed under the Solid::Capability namespace.
-−
-<syntaxhighlight lang="cpp-qt">
-Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
-−
-//get a list of all devices that are AudioHw
-foreach (Solid::Device device, Solid::Device::listFromType(Solid::DeviceInterface::AudioInterface, QString()))
-−
-   kDebug() << device.udi().toLatin1().constData();
-−
-</syntaxhighlight>
-−
-In this example Solid::DeviceManager::findDevicesFromQuery looks for a device with any parent and the Solid::Capability::AudioHw capability.  If we had wanted to specify an AudioHw device with the parent "real_specific_parent" it would look like this:
-−
-<syntaxhighlight lang="cpp-qt">Solid::Device::listFromType(Solid::Capability::AudioHw,"real_specific_parent" )</syntaxhighlight>
-The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial2/ kdeexamples/solid/tutorial2/]".
-−
-== What do we do with a device once we get it? ==
-Now that we got a device, what do we do with it?  First let's look at the relationship between the Solid::Device and Solid::Capability. A Solid::Device can contain many Solid::Capability.  A device can be tested to have a capability in the following way:
-<syntaxhighlight lang="cpp-qt">
-Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
-−
-//get a Processor
-QList<Solid::Device> list = Solid::Device::listFromType(Solid::DeviceInterface::Processor, QString());
-−
-//take the first processor
-Solid::Device device = list[0];
-if(device.is<Solid::Processor>() ) kDebug() << "We've got a processor!";
-else kDebug() << "Device is not a processor.";
-−
-Solid::Processor *processor = device.as<Solid::Processor>();
-kDebug() << "This processors maximum speed is:" << processor->maxSpeed();
-−
-</syntaxhighlight>
-−
-To actually use this device as a processor we need to do the following:
-<syntaxhighlight lang="cpp-qt">
-    Solid::Processor *processor = device.as<Solid::Processor>();
-</syntaxhighlight>
-The complete program along with the CMake files required to build it can be found under "[http://websvn.kde.org/trunk/KDE/kdeexamples/solid/tutorial3/ kdeexamples/solid/tutorial3/]".
-−
-== solid-hardware tool ==
-−
-kdebase-runtime provides solid-hardware, a command line tool to investigate available devices.
-−
-Listing udi for all installed devices:
-−
-<syntaxhighlight lang="text">
-solid-hardware list
-</syntaxhighlight>
-−
-Listing full details for all installed devices:
-−
-<syntaxhighlight lang="text">
-solid-hardware list details
-</syntaxhighlight>
-−
-Listing all audio hardware devices:
-−
-<syntaxhighlight lang="text">
-solid-hardware query 'IS AudioInterface'
-</syntaxhighlight>
 [[Category:Tutorial]]