Difference between revisions of "Development/Tutorials/Solid/Introduction"

Jump to: navigation, search
m (Text replace - "<code>" to "<syntaxhighlight lang="text">")
m (Text replace - "</code>" to "</syntaxhighlight>")
Line 15: Line 15:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
     Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
 
     Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();
</code>
+
</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:
 
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:
Line 24: Line 24:
 
     kDebug() << device.udi();
 
     kDebug() << device.udi();
 
}
 
}
</code>
+
</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.
 
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.
Line 41: Line 41:
 
   kDebug() << device.udi().toLatin1().constData();
 
   kDebug() << device.udi().toLatin1().constData();
 
}
 
}
</code>
+
</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:
 
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" )</code>
+
<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/]".
 
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/]".
  
Line 64: Line 64:
 
kDebug() << "This processors maximum speed is:" << processor->maxSpeed();
 
kDebug() << "This processors maximum speed is:" << processor->maxSpeed();
  
</code>
+
</syntaxhighlight>
  
 
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:
 
<syntaxhighlight lang="cpp-qt">
 
<syntaxhighlight lang="cpp-qt">
 
     Solid::Processor *processor = device.as<Solid::Processor>();
 
     Solid::Processor *processor = device.as<Solid::Processor>();
</code>
+
</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/]".
 
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/]".
  
Line 80: Line 80:
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
solid-hardware list
 
solid-hardware list
</code>
+
</syntaxhighlight>
  
 
Listing full details for all installed devices:
 
Listing full details for all installed devices:
Line 86: Line 86:
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
solid-hardware list details
 
solid-hardware list details
</code>
+
</syntaxhighlight>
  
 
Listing all audio hardware devices:
 
Listing all audio hardware devices:
Line 92: Line 92:
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
solid-hardware query 'IS AudioInterface'
 
solid-hardware query 'IS AudioInterface'
</code>
+
</syntaxhighlight>
  
 
[[Category:Tutorial]]
 
[[Category:Tutorial]]

Revision as of 20:56, 29 June 2011

Contents

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 solid.kde.org.

For a more detailed (still not complete!) description, read here.

Who is this tutorial 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

  • A working KDE4 development environment. Documentation on setting up a KDE environment can be found here.

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.

    Solid::DeviceNotifier *notifier = Solid::DeviceNotifier::instance();

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:

foreach( Solid::Device device, Solid::Device::allDevices() )
{
    //print the name of device
    kDebug() << device.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 "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.

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();
}

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:

Solid::Device::listFromType(Solid::Capability::AudioHw,"real_specific_parent" )

The complete program along with the CMake files required to build it can be found under "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:

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();

To actually use this device as a processor we need to do the following:

    Solid::Processor *processor = device.as<Solid::Processor>();

The complete program along with the CMake files required to build it can be found under "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:

solid-hardware list

Listing full details for all installed devices:

solid-hardware list details

Listing all audio hardware devices:

solid-hardware query 'IS AudioInterface'

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal