iio.Device Class Reference

iio.Device class: Contains the representation of an IIO device. More...

Inheritance diagram for iio.Device:

Collaboration diagram for iio.Device:

Public Member Functions
Channel	get_channel (string name, bool output=false)
	Get the iio.Channel object of the specified name. More...
void	set_trigger (Trigger trig)
	Affect a trigger to this device. More...
Trigger	get_trigger ()
	Get the current trigger affected to this device. More...
uint	get_sample_size (ChannelsMask mask)
	Get the current sample size of the device. More...
void	reg_write (uint addr, uint value)
	Set a value to one register of this device. More...
uint	reg_read (uint addr)
	Read the content of a register of this device. More...
def	__init__ (self, ctx, _device)
def	context (self)
Public Member Functions inherited from iio._DeviceOrTrigger
def	__init__ (self, _ctx, _device)
def	reg_write (self, reg, value)
def	reg_read (self, reg)
def	find_channel (self, name_or_id, is_output=False)
Public Member Functions inherited from iio._IIO_Object
def	__init__ (self, hdl, parent)
def	__eq__ (self, other)

Public Attributes
readonly Context	ctx
	Gets the context of the current device. More...
readonly string	id
	An identifier of this device. More...
readonly string	name
	The name of this device. More...
readonly List< Attr >	attrs
	A list of all the attributes that this device has. More...
readonly List< Attr >	debug_attrs
	A list of all the debug attributes that this device has. More...
readonly List< Channel >	channels
	A list of all the iio.Channel objects that this device possesses. More...
	ctx

Properties
string	label [get]
	The label of this device. More...
bool	hwmon [get]
	True if the device is a hardware monitoring device, False if it is a IIO device. More...
List< Attr >	buffer_attrs [get]
	A list of all the buffer attributes that this device has. More...
	trigger
	hwmon
Properties inherited from iio._DeviceOrTrigger
	id
	name
	label
	attrs
	debug_attrs
	buffer_attrs
	channels

Detailed Description

iio.Device class: Contains the representation of an IIO device.

Contains the representation of an IIO device.

Constructor & Destructor Documentation

__init__()

def iio.Device.__init__	(		self,
			ctx,
			_device
	)

Initialize a new instance of the Device class.

:param ctx: type=iio.Context
    A valid instance of the iio.Context class.
:param _device: type=_DevicePtr
    A pointer to an IIO device.

returns: type=iio.Device
    An new instance of this class

Member Function Documentation

context()

def iio.Device.context

(

self

)

Context for the device.
type: iio.Context

get_channel()

Channel iio.Device.get_channel ( string  name, bool  output = false  )

inline

Get the iio.Channel object of the specified name.

Parameters

name	Name or ID of the channel to look for
output	true if you are looking for an output channel, otherwise false.

Exceptions

IioLib.IIOException

The IIO device with the specified name or ID could not be found in the current context.

get_sample_size()

uint iio.Device.get_sample_size ( ChannelsMask  mask )

inline

Get the current sample size of the device.

The sample size varies each time channels get enabled or disabled.

Exceptions

IioLib.IIOException

Internal error. Please report any bug.

get_trigger()

Trigger iio.Device.get_trigger ( )

inline

Get the current trigger affected to this device.

Returns

An instance of the iio.Trigger class.

Exceptions

IioLib.IIOException

The instance could not be retrieved.

reg_read()

uint iio.Device.reg_read ( uint  addr )

inline

Read the content of a register of this device.

Parameters

addr	The address of the register concerned.

Exceptions

IioLib.IIOException

The register could not be read.

reg_write()

void iio.Device.reg_write ( uint  addr, uint  value  )

inline

Set a value to one register of this device.

Parameters

addr	The address of the register concerned.
value	The value that will be used for this register.

Exceptions

IioLib.IIOException

The register could not be written.

set_trigger()

void iio.Device.set_trigger ( Trigger  trig )

inline

Affect a trigger to this device.

Parameters

trig	A valid instance of the iio.Trigger class.

Exceptions

IioLib.IIOException

The trigger could not be set.

Member Data Documentation

attrs

readonly List<Attr> iio.Device.attrs

A list of all the attributes that this device has.

channels

readonly List<Channel> iio.Device.channels

A list of all the iio.Channel objects that this device possesses.

ctx

readonly Context iio.Device.ctx

Gets the context of the current device.

debug_attrs

readonly List<Attr> iio.Device.debug_attrs

A list of all the debug attributes that this device has.

id

readonly string iio.Device.id

An identifier of this device.

The identifier is only valid in this IIO context

name

readonly string iio.Device.name

The name of this device.

Property Documentation

buffer_attrs

List<Attr> iio.Device.buffer_attrs

get

A list of all the buffer attributes that this device has.

hwmon [1/2]

bool iio.Device.hwmon

get

True if the device is a hardware monitoring device, False if it is a IIO device.

hwmon [2/2]

iio.Device.hwmon

static

Initial value:

=  property(
        lambda self: self._id[:5] == "hwmon", None, None,
        "Contains True if the device is a hardware-monitoring device, False if it is a IIO device.\n\ttype=bool",
    )

label

string iio.Device.label

get

The label of this device.

trigger

iio.Device.trigger

static

Initial value:

=  property(
        _get_trigger,
        _set_trigger,
        None,
        "Contains the configured trigger for this IIO device.\n\ttype=iio.Trigger",
    )

---

The documentation for this class was generated from the following files:

• bindings/csharp/Device.cs
• bindings/python/iio.py