libiio
Public Member Functions | Properties | List of all members
iio.Trigger Class Reference

iio.Trigger class: Contains the representation of an IIO device that can act as a trigger. More...

Inheritance diagram for iio.Trigger:
Inheritance graph
[legend]
Collaboration diagram for iio.Trigger:
Collaboration graph
[legend]

Public Member Functions

void set_rate (ulong rate)
 Configure a new frequency for this trigger. More...
 
ulong get_rate ()
 Get the currently configured frequency of this trigger. More...
 
new void set_trigger (Trigger trig)
 Set Trigger. More...
 
new Trigger get_trigger ()
 Get trigger. More...
 
def __init__ (self, ctx, _device)
 
- 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 Member Functions inherited from iio.Device
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)
 

Properties

 frequency
 
- Properties inherited from iio._DeviceOrTrigger
 id
 
 name
 
 label
 
 attrs
 
 debug_attrs
 
 buffer_attrs
 
 channels
 
- Properties inherited from iio.Device
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< Attrbuffer_attrs [get]
 A list of all the buffer attributes that this device has. More...
 
 trigger
 
 hwmon
 

Additional Inherited Members

- Public Attributes inherited from iio.Device
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< Attrattrs
 A list of all the attributes that this device has. More...
 
readonly List< Attrdebug_attrs
 A list of all the debug attributes that this device has. More...
 
readonly List< Channelchannels
 A list of all the iio.Channel objects that this device possesses. More...
 
 ctx
 

Detailed Description

iio.Trigger class: Contains the representation of an IIO device that can act as a trigger.

Contains the representation of an IIO device that can act as a trigger.

Constructor & Destructor Documentation

◆ __init__()

def iio.Trigger.__init__ (   self,
  ctx,
  _device 
)
Initialize a new instance of the Trigger class.

:param _device: type=iio._DevicePtr
    A pointer to an IIO device.

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

Member Function Documentation

◆ get_rate()

ulong iio.Trigger.get_rate ( )
inline

Get the currently configured frequency of this trigger.

Exceptions
IioLib.IIOExceptionThe configured frequency could not be obtained.

◆ get_trigger()

new Trigger iio.Trigger.get_trigger ( )
inline

Get trigger.

◆ set_rate()

void iio.Trigger.set_rate ( ulong  rate)
inline

Configure a new frequency for this trigger.

Exceptions
IioLib.IIOExceptionThe new frequency could not be set.

◆ set_trigger()

new void iio.Trigger.set_trigger ( Trigger  trig)
inline

Set Trigger.

Property Documentation

◆ frequency

iio.Trigger.frequency
static
Initial value:
= property(
_get_rate,
_set_rate,
None,
"Configured frequency (in Hz) of this trigger\n\ttype=int",
)

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