│ │ │ │
│ │ │ │ │ │ │ │
│ │ │ │

Device

│ │ │ │
│ │ │ │

Members

│ │ │ │ +
│ │ │ │ +
│ │ │ │ +class iio.Device(ctx, _device)[source]
│ │ │ │ +

Contains the representation of an IIO device.

│ │ │ │ +
│ │ │ │ +
│ │ │ │ +property attrs
│ │ │ │ +

List of attributes for this IIO device. │ │ │ │ +type=dict of iio.DeviceAttr

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property buffer_attrs
│ │ │ │ +

List of buffer attributes for this IIO device. │ │ │ │ +type=dict of iio.DeviceBufferAttr

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property channels
│ │ │ │ +

List of channels available with this IIO device. │ │ │ │ +type=list of iio.Channel objects

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property context
│ │ │ │ +

Context for the device. │ │ │ │ +type: iio.Context

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property debug_attrs
│ │ │ │ +

List of debug attributes for this IIO device. │ │ │ │ +type=dict of iio.DeviceDebugAttr

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +find_channel(name_or_id, is_output=False)
│ │ │ │ +

Find a IIO channel by its name or ID.

│ │ │ │ +
│ │ │ │ +
Parameters
│ │ │ │ +
    │ │ │ │ +
  • name_or_id – type=str │ │ │ │ +The name or ID of the channel to find

  • │ │ │ │ +
  • is_output – type=bool │ │ │ │ +Set to True to search for an output channel

  • │ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
returns: type=iio.Device or type=iio.Trigger

The IIO Device

│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property id
│ │ │ │ +

An identifier of this device, only valid in this IIO context. │ │ │ │ +type=str

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property name
│ │ │ │ +

The name of this device. │ │ │ │ +type=str

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +reg_read(reg)
│ │ │ │ +

Read the content of a register of this device.

│ │ │ │ +
│ │ │ │ +
Parameters
│ │ │ │ +

reg – type=int │ │ │ │ +The register address

│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
returns: type=int

The value of the register

│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +reg_write(reg, value)
│ │ │ │ +

Set a value to one register of this device.

│ │ │ │ +
│ │ │ │ +
Parameters
│ │ │ │ +
    │ │ │ │ +
  • reg – type=int │ │ │ │ +The register address

  • │ │ │ │ +
  • value – type=int │ │ │ │ +The value that will be used for this register

  • │ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property sample_size
│ │ │ │ +

Sample size of this device. │ │ │ │ +type: int

│ │ │ │ +

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

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +set_kernel_buffers_count(count)
│ │ │ │ +

Set the number of kernel buffers to use with the specified device.

│ │ │ │ +
│ │ │ │ +
Parameters
│ │ │ │ +

count – type=int │ │ │ │ +The number of kernel buffers

│ │ │ │ +
│ │ │ │ +
│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ +
│ │ │ │ +property trigger
│ │ │ │ +

Contains the configured trigger for this IIO device. │ │ │ │ +type=iio.Trigger

│ │ │ │ +
│ │ │ │ + │ │ │ │ +
│ │ │ │ + │ │ │ │
│ │ │ │
│ │ │ │
│ │ │ │

Device attributes

│ │ │ │
│ │ │ │
│ │ │ │ class iio.DeviceDebugAttr(device, name)[source]
│ │ │ │ ├── html2text {} │ │ │ │ │ @@ -18,14 +18,65 @@ │ │ │ │ │ libiio-py │ │ │ │ │ * » │ │ │ │ │ * Device │ │ │ │ │ * View_page_source │ │ │ │ │ =============================================================================== │ │ │ │ │ ****** Device¶ ****** │ │ │ │ │ ***** Members¶ ***** │ │ │ │ │ + classiio.Device(ctx, _device)[source]¶ │ │ │ │ │ + Contains the representation of an IIO device. │ │ │ │ │ + propertyattrs¶ │ │ │ │ │ + List of attributes for this IIO device. type=dict of iio.DeviceAttr │ │ │ │ │ + propertybuffer_attrs¶ │ │ │ │ │ + List of buffer attributes for this IIO device. type=dict of │ │ │ │ │ + iio.DeviceBufferAttr │ │ │ │ │ + propertychannels¶ │ │ │ │ │ + List of channels available with this IIO device. type=list of │ │ │ │ │ + iio.Channel objects │ │ │ │ │ + propertycontext¶ │ │ │ │ │ + Context for the device. type: iio.Context │ │ │ │ │ + propertydebug_attrs¶ │ │ │ │ │ + List of debug attributes for this IIO device. type=dict of │ │ │ │ │ + iio.DeviceDebugAttr │ │ │ │ │ + find_channel(name_or_id, is_output=False)¶ │ │ │ │ │ + Find a IIO channel by its name or ID. │ │ │ │ │ + Parameters │ │ │ │ │ + * name_or_id – type=str The name or ID of the channel │ │ │ │ │ + to find │ │ │ │ │ + * is_output – type=bool Set to True to search for an │ │ │ │ │ + output channel │ │ │ │ │ + returns: type=iio.Device or type=iio.Trigger │ │ │ │ │ + The IIO Device │ │ │ │ │ + propertyid¶ │ │ │ │ │ + An identifier of this device, only valid in this IIO context. │ │ │ │ │ + type=str │ │ │ │ │ + propertyname¶ │ │ │ │ │ + The name of this device. type=str │ │ │ │ │ + reg_read(reg)¶ │ │ │ │ │ + Read the content of a register of this device. │ │ │ │ │ + Parameters │ │ │ │ │ + reg – type=int The register address │ │ │ │ │ + returns: type=int │ │ │ │ │ + The value of the register │ │ │ │ │ + reg_write(reg, value)¶ │ │ │ │ │ + Set a value to one register of this device. │ │ │ │ │ + Parameters │ │ │ │ │ + * reg – type=int The register address │ │ │ │ │ + * value – type=int The value that will be used for this │ │ │ │ │ + register │ │ │ │ │ + propertysample_size¶ │ │ │ │ │ + Sample size of this device. type: int │ │ │ │ │ + The sample size varies each time channels get enabled or disabled. │ │ │ │ │ + set_kernel_buffers_count(count)¶ │ │ │ │ │ + Set the number of kernel buffers to use with the specified device. │ │ │ │ │ + Parameters │ │ │ │ │ + count – type=int The number of kernel buffers │ │ │ │ │ + propertytrigger¶ │ │ │ │ │ + Contains the configured trigger for this IIO device. │ │ │ │ │ + type=iio.Trigger │ │ │ │ │ =============================================================================== │ │ │ │ │ ***** Device attributes¶ ***** │ │ │ │ │ classiio.DeviceDebugAttr(device, name)[source]¶ │ │ │ │ │ Represents a debug attribute of an IIO device. │ │ │ │ │ propertyfilename¶ │ │ │ │ │ The filename in sysfs to which this attribute is bound. type=str │ │ │ │ │ propertyname¶ │ │ │ ├── ./usr/share/doc/libiio0-doc/v0.21/python/genindex.html │ │ │ │ @@ -164,14 +164,15 @@ │ │ │ │ | M │ │ │ │ | N │ │ │ │ | R │ │ │ │ | S │ │ │ │ | T │ │ │ │ | V │ │ │ │ | W │ │ │ │ + | X │ │ │ │ │ │ │ │
│ │ │ │

A

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
│ │ │ │
│ │ │ │ │ │ │ │

B

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
│ │ │ │ │ │ │ │

C

│ │ │ │ │ │ │ │
    │ │ │ │ -
  • channels() (iio.Trigger property) │ │ │ │ +
  • channels() (iio.Device property) │ │ │ │ + │ │ │ │ +
  • │ │ │ │ +
  • clone() (iio.NetworkContext method) │ │ │ │ +
  • │ │ │ │ +
  • context() (iio.Device property) │ │ │ │
  • │ │ │ │
  • ContextBuilder (class in iio_attr) │ │ │ │ │ │ │ │
      │ │ │ │
    • (class in iio_readdev) │ │ │ │
    • │ │ │ │
    • (class in iio_writedev) │ │ │ │ @@ -237,48 +256,68 @@ │ │ │ │

      D

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │ │ │ │ │ │

      F

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │ │ │ │ │ │

      I

      │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │ │
      │ │ │ │ │ │ │ │

      N

      │ │ │ │ │ │ │ │ │ │ │ │ + │ │ │ │
      │ │ │ │ │ │ │ │

      R

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │ │ │ │ │ │

      S

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │ │ │ │ │ │

      T

      │ │ │ │ │ │ │ │ │ │ │ │ + │ │ │ │
      │ │ │ │ │ │ │ │

      V

      │ │ │ │ │ │ │ │ │ │ │ │ + │ │ │ │
      │ │ │ │ │ │ │ │

      W

      │ │ │ │ │ │ │ │ │ │ │ │
      │ │ │ │ │ │ │ │ +

      X

      │ │ │ │ + │ │ │ │ + │ │ │ │ +
      │ │ │ │ + │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │