aardvark_py package

Module contents

class aardvark_py.AardvarkExt[source]
class aardvark_py.AardvarkVersion[source]
aardvark_py.aa_async_poll(aardvark, timeout)[source]

usage: int return = aa_async_poll(Aardvark aardvark, int timeout)

aardvark_py.aa_close(aardvark)[source]

usage: int return = aa_close(Aardvark aardvark)

aardvark_py.aa_configure(aardvark, config)[source]

usage: int return = aa_configure(Aardvark aardvark, AardvarkConfig config)

aardvark_py.aa_features(aardvark)[source]

usage: int return = aa_features(Aardvark aardvark)

aardvark_py.aa_find_devices(devices)[source]

usage: (int return, u16[] devices) = aa_find_devices(u16[] devices)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_find_devices_ext(devices, unique_ids)[source]

usage: (int return, u16[] devices, u32[] unique_ids) = aa_find_devices_ext(u16[] devices, u32[] unique_ids)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_gpio_change(aardvark, timeout)[source]

usage: int return = aa_gpio_change(Aardvark aardvark, u16 timeout)

aardvark_py.aa_gpio_direction(aardvark, direction_mask)[source]

usage: int return = aa_gpio_direction(Aardvark aardvark, u08 direction_mask)

aardvark_py.aa_gpio_get(aardvark)[source]

usage: int return = aa_gpio_get(Aardvark aardvark)

aardvark_py.aa_gpio_pullup(aardvark, pullup_mask)[source]

usage: int return = aa_gpio_pullup(Aardvark aardvark, u08 pullup_mask)

aardvark_py.aa_gpio_set(aardvark, value)[source]

usage: int return = aa_gpio_set(Aardvark aardvark, u08 value)

aardvark_py.aa_i2c_bitrate(aardvark, bitrate_khz)[source]

usage: int return = aa_i2c_bitrate(Aardvark aardvark, int bitrate_khz)

aardvark_py.aa_i2c_bus_timeout(aardvark, timeout_ms)[source]

usage: int return = aa_i2c_bus_timeout(Aardvark aardvark, u16 timeout_ms)

aardvark_py.aa_i2c_free_bus(aardvark)[source]

usage: int return = aa_i2c_free_bus(Aardvark aardvark)

aardvark_py.aa_i2c_monitor_disable(aardvark)[source]

usage: int return = aa_i2c_monitor_disable(Aardvark aardvark)

aardvark_py.aa_i2c_monitor_enable(aardvark)[source]

usage: int return = aa_i2c_monitor_enable(Aardvark aardvark)

aardvark_py.aa_i2c_monitor_read(aardvark, data)[source]

usage: (int return, u16[] data) = aa_i2c_monitor_read(Aardvark aardvark, u16[] data)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_i2c_pullup(aardvark, pullup_mask)[source]

usage: int return = aa_i2c_pullup(Aardvark aardvark, u08 pullup_mask)

aardvark_py.aa_i2c_read(aardvark, slave_addr, flags, data_in)[source]

usage: (int return, u08[] data_in) = aa_i2c_read(Aardvark aardvark, u16 slave_addr, AardvarkI2cFlags flags, u08[] data_in)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_i2c_read_ext(aardvark, slave_addr, flags, data_in)[source]

usage: (int return, u08[] data_in, u16 num_read) = aa_i2c_read_ext(Aardvark aardvark, u16 slave_addr, AardvarkI2cFlags flags, u08[] data_in)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_i2c_slave_disable(aardvark)[source]

usage: int return = aa_i2c_slave_disable(Aardvark aardvark)

aardvark_py.aa_i2c_slave_enable(aardvark, addr, maxTxBytes, maxRxBytes)[source]

usage: int return = aa_i2c_slave_enable(Aardvark aardvark, u08 addr, u16 maxTxBytes, u16 maxRxBytes)

aardvark_py.aa_i2c_slave_read(aardvark, data_in)[source]

usage: (int return, u08 addr, u08[] data_in) = aa_i2c_slave_read(Aardvark aardvark, u08[] data_in)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_i2c_slave_read_ext(aardvark, data_in)[source]

usage: (int return, u08 addr, u08[] data_in, u16 num_read) = aa_i2c_slave_read_ext(Aardvark aardvark, u08[] data_in)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_i2c_slave_set_response(aardvark, data_out)[source]

usage: int return = aa_i2c_slave_set_response(Aardvark aardvark, u08[] data_out)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

aardvark_py.aa_i2c_slave_write_stats(aardvark)[source]

usage: int return = aa_i2c_slave_write_stats(Aardvark aardvark)

aardvark_py.aa_i2c_slave_write_stats_ext(aardvark)[source]

usage: (int return, u16 num_written) = aa_i2c_slave_write_stats_ext(Aardvark aardvark)

aardvark_py.aa_i2c_write(aardvark, slave_addr, flags, data_out)[source]

usage: int return = aa_i2c_write(Aardvark aardvark, u16 slave_addr, AardvarkI2cFlags flags, u08[] data_out)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

aardvark_py.aa_i2c_write_ext(aardvark, slave_addr, flags, data_out)[source]

usage: (int return, u16 num_written) = aa_i2c_write_ext(Aardvark aardvark, u16 slave_addr, AardvarkI2cFlags flags, u08[] data_out)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

aardvark_py.aa_i2c_write_read(aardvark, slave_addr, flags, out_data, in_data)[source]

usage: (int return, u16 num_written, u08[] in_data, u16 num_read) = aa_i2c_write_read(Aardvark aardvark, u16 slave_addr, AardvarkI2cFlags flags, u08[] out_data, u08[] in_data)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_log(aardvark, level, handle)[source]

usage: int return = aa_log(Aardvark aardvark, int level, int handle)

aardvark_py.aa_open(port_number)[source]

usage: Aardvark return = aa_open(int port_number)

aardvark_py.aa_open_ext(port_number)[source]

usage: (Aardvark return, AardvarkExt aa_ext) = aa_open_ext(int port_number)

aardvark_py.aa_port(aardvark)[source]

usage: int return = aa_port(Aardvark aardvark)

aardvark_py.aa_sleep_ms(milliseconds)[source]

usage: u32 return = aa_sleep_ms(u32 milliseconds)

aardvark_py.aa_spi_bitrate(aardvark, bitrate_khz)[source]

usage: int return = aa_spi_bitrate(Aardvark aardvark, int bitrate_khz)

aardvark_py.aa_spi_configure(aardvark, polarity, phase, bitorder)[source]

usage: int return = aa_spi_configure(Aardvark aardvark, AardvarkSpiPolarity polarity, AardvarkSpiPhase phase, AardvarkSpiBitorder bitorder)

aardvark_py.aa_spi_master_ss_polarity(aardvark, polarity)[source]

usage: int return = aa_spi_master_ss_polarity(Aardvark aardvark, AardvarkSpiSSPolarity polarity)

aardvark_py.aa_spi_slave_disable(aardvark)[source]

usage: int return = aa_spi_slave_disable(Aardvark aardvark)

aardvark_py.aa_spi_slave_enable(aardvark)[source]

usage: int return = aa_spi_slave_enable(Aardvark aardvark)

aardvark_py.aa_spi_slave_read(aardvark, data_in)[source]

usage: (int return, u08[] data_in) = aa_spi_slave_read(Aardvark aardvark, u08[] data_in)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_spi_slave_set_response(aardvark, data_out)[source]

usage: int return = aa_spi_slave_set_response(Aardvark aardvark, u08[] data_out)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

aardvark_py.aa_spi_write(aardvark, data_out, data_in)[source]

usage: (int return, u08[] data_in) = aa_spi_write(Aardvark aardvark, u08[] data_out, u08[] data_in)

All arrays can be passed into the API as an ArrayType object or as a tuple (array, length), where array is an ArrayType object and length is an integer. The user-specified length would then serve as the length argument to the API funtion (please refer to the product datasheet). If only the array is provided, the array’s intrinsic length is used as the argument to the underlying API function.

Additionally, for arrays that are filled by the API function, an integer can be passed in place of the array argument and the API will automatically create an array of that length. All output arrays, whether passed in or generated, are passed back in the returned tuple.

aardvark_py.aa_status_string(status)[source]

usage: str return = aa_status_string(int status)

aardvark_py.aa_target_power(aardvark, power_mask)[source]

usage: int return = aa_target_power(Aardvark aardvark, u08 power_mask)

aardvark_py.aa_unique_id(aardvark)[source]

usage: u32 return = aa_unique_id(Aardvark aardvark)

aardvark_py.aa_version(aardvark)[source]

usage: (int return, AardvarkVersion version) = aa_version(Aardvark aardvark)

aardvark_py.array_f32(n)[source]
aardvark_py.array_f64(n)[source]
aardvark_py.array_s08(n)[source]
aardvark_py.array_s16(n)[source]
aardvark_py.array_s32(n)[source]
aardvark_py.array_s64(n)[source]
aardvark_py.array_u08(n)[source]
aardvark_py.array_u16(n)[source]
aardvark_py.array_u32(n)[source]
aardvark_py.array_u64(n)[source]