Skip to main content

A python API for the SmartWave interface.

Project description

SmartWaveAPI

A python API for the SmartWave interface.

Installation

  • This package requires python version 3.
  • To install this package, run the following command:
pip install SmartWaveAPI

Usage

It is recommended to use the with..as pattern to implicitly call cleanup functions when resources of the SmartWave device are no longer needed.

Basic I2C script

from SmartWaveAPI import SmartWave

with SmartWave().connect() as sw:
    with sw.createI2CConfig() as i2c:
        # write 0xaa, 0x55 to device with address 0x20
        i2c.write(0x20, bytes([0xaa, 0x55]))
        # read 2 bytes from device with address 0x20
        i2c.read(0x20, 2)
        # write value 0x0f to register 0xaa of device at 0x20
        i2c.writeRegister(0x20, 0xaa.to_bytes(1, "big"), 0x0f.to_bytes(1, "big"))
        # read value of 1-byte register 0xaa of device at 0x20
        i2c.readRegister(0x20, 0xaa.to_bytes(1, "big"), 1)

Basic SPI script

from SmartWaveAPI import SmartWave

with SmartWave().connect() as sw:
    with sw.createSPIConfig() as spi:
        # write 0xaa, 0x55 via SPI and read simultaneously
        spi.write([0xaa, 0x55])

Documentation

Further documentation can be found on our documentation page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smartwaveapi-2.2.1.tar.gz (628.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

smartwaveapi-2.2.1-py3-none-any.whl (628.4 kB view details)

Uploaded Python 3

File details

Details for the file smartwaveapi-2.2.1.tar.gz.

File metadata

  • Download URL: smartwaveapi-2.2.1.tar.gz
  • Upload date:
  • Size: 628.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.13.2

File hashes

Hashes for smartwaveapi-2.2.1.tar.gz
Algorithm Hash digest
SHA256 20be9e4229a47de2d7f7dc70c65637ce0b32a6b5bf8aa3412497ad08f327f957
MD5 d6a6c60dbbca26ad1eb30b927abd0114
BLAKE2b-256 a18547e77636b2eeed155ceec6dc434bea9aa65442d93d4820f14d2dc9780779

See more details on using hashes here.

File details

Details for the file smartwaveapi-2.2.1-py3-none-any.whl.

File metadata

  • Download URL: smartwaveapi-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 628.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.13.2

File hashes

Hashes for smartwaveapi-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b7661eb4ac27025108d500045e053d07e10afa7feafde199b2cbbc36507b072
MD5 609f79cdbbf66f89ceca41e5cd72a311
BLAKE2b-256 b58930caed8eff5f20a72d0243ebe7d4328b709d071bad0bc4a9e45a187a4d14

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page