# ADXL355 SPI Library
Welcome to the ADXL355 SPI Library, a comprehensive Python library for interfacing with the ADXL355 accelerometer via SPI communication. This library is designed to provide a simple and intuitive API for accessing the full capabilities of the ADXL355 sensor, allowing for both basic and advanced accelerometer data handling.
## Features
- **Easy-to-use**: Simple functions to read and write data from the ADXL355.
- **Real-Time Data Acquisition**: Support for real-time acceleration data acquisition and processing.
- **Conversion Utilities**: Includes utilities for converting raw sensor data into meaningful units (g, cm/s²).
- **Comprehensive Examples**: Includes several examples demonstrating the library's capabilities.
## Installation
Clone this repository and install the package using pip:
```bash
git clone https://github.com/oaslananka/adxl355_spi_library.git
cd adxl355_spi_library
pip install .
```
## Usage
Import the library and initialize the accelerometer:
```python
from adxl355 import Adxl355
accelerometer = Adxl355()
```
To read acceleration data:
```python
x, y, z = accelerometer.get_axis()
print(f"Acceleration - X: {x} g, Y: {y} g, Z: {z} g")
```
For detailed examples, refer to the `examples/` directory.
## Documentation
For more detailed information about the library's API and functionalities, visit the [documentation](https://github.com/oaslananka/adxl355_spi_library#readme).
## Contributing
Contributions are welcome! Please refer to our `CONTRIBUTING.md` for guidelines on how to make contributions to this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Authors
- **[oaslananka](https://github.com/oaslananka)**
## Acknowledgments
- Thanks to everyone who has contributed to this project!
Raw data
{
"_id": null,
"home_page": "https://github.com/oaslananka/adxl355_spi_library",
"name": "adxl355-library",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "ADXL355 accelerometer SPI hardware",
"author": "oaslananka",
"author_email": "info@oaslananka.dev",
"download_url": "https://files.pythonhosted.org/packages/94/3a/0bb248cd30dd0f8dbb00d29915d1842273b263b92e8dcb8b770f4bd6a214/adxl355_library-0.1.0.tar.gz",
"platform": null,
"description": "\r\n# ADXL355 SPI Library\r\n\r\nWelcome to the ADXL355 SPI Library, a comprehensive Python library for interfacing with the ADXL355 accelerometer via SPI communication. This library is designed to provide a simple and intuitive API for accessing the full capabilities of the ADXL355 sensor, allowing for both basic and advanced accelerometer data handling.\r\n\r\n## Features\r\n\r\n- **Easy-to-use**: Simple functions to read and write data from the ADXL355.\r\n- **Real-Time Data Acquisition**: Support for real-time acceleration data acquisition and processing.\r\n- **Conversion Utilities**: Includes utilities for converting raw sensor data into meaningful units (g, cm/s\u00c2\u00b2).\r\n- **Comprehensive Examples**: Includes several examples demonstrating the library's capabilities.\r\n\r\n## Installation\r\n\r\nClone this repository and install the package using pip:\r\n\r\n```bash\r\ngit clone https://github.com/oaslananka/adxl355_spi_library.git\r\ncd adxl355_spi_library\r\npip install .\r\n```\r\n\r\n## Usage\r\n\r\nImport the library and initialize the accelerometer:\r\n\r\n```python\r\nfrom adxl355 import Adxl355\r\n\r\naccelerometer = Adxl355()\r\n```\r\n\r\nTo read acceleration data:\r\n\r\n```python\r\nx, y, z = accelerometer.get_axis()\r\nprint(f\"Acceleration - X: {x} g, Y: {y} g, Z: {z} g\")\r\n```\r\n\r\nFor detailed examples, refer to the `examples/` directory.\r\n\r\n## Documentation\r\n\r\nFor more detailed information about the library's API and functionalities, visit the [documentation](https://github.com/oaslananka/adxl355_spi_library#readme).\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please refer to our `CONTRIBUTING.md` for guidelines on how to make contributions to this project.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Authors\r\n\r\n- **[oaslananka](https://github.com/oaslananka)**\r\n\r\n## Acknowledgments\r\n\r\n- Thanks to everyone who has contributed to this project!\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for interfacing with the ADXL355 accelerometer via SPI.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/oaslananka/adxl355_spi_library#readme",
"Homepage": "https://github.com/oaslananka/adxl355_spi_library",
"Source": "https://github.com/oaslananka/adxl355_spi_library",
"Tracker": "https://github.com/oaslananka/adxl355_spi_library/issues"
},
"split_keywords": [
"adxl355",
"accelerometer",
"spi",
"hardware"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b945c1dcc6c9447fa6144da423ea4f35a413ee02d279f93a902e467c2795a9da",
"md5": "afb5656feae89b4c83f2d55c3938c3cb",
"sha256": "d0e4eabe96463205e197927273d24b7c8f50dd3adddd9fe1ba941f0b63861c64"
},
"downloads": -1,
"filename": "adxl355_library-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afb5656feae89b4c83f2d55c3938c3cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7042,
"upload_time": "2024-06-26T14:47:21",
"upload_time_iso_8601": "2024-06-26T14:47:21.348570Z",
"url": "https://files.pythonhosted.org/packages/b9/45/c1dcc6c9447fa6144da423ea4f35a413ee02d279f93a902e467c2795a9da/adxl355_library-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "943a0bb248cd30dd0f8dbb00d29915d1842273b263b92e8dcb8b770f4bd6a214",
"md5": "08fc57cc59b4dea72c0d2a5d4bb45a0e",
"sha256": "a0b10083b77349cb0d37cdd626af9338944c72fef39c77a15f7a28bd849cdf95"
},
"downloads": -1,
"filename": "adxl355_library-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "08fc57cc59b4dea72c0d2a5d4bb45a0e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6664,
"upload_time": "2024-06-26T14:47:23",
"upload_time_iso_8601": "2024-06-26T14:47:23.185093Z",
"url": "https://files.pythonhosted.org/packages/94/3a/0bb248cd30dd0f8dbb00d29915d1842273b263b92e8dcb8b770f4bd6a214/adxl355_library-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-26 14:47:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oaslananka",
"github_project": "adxl355_spi_library",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "spidev",
"specs": [
[
"==",
"3.5"
]
]
},
{
"name": "wiringpi",
"specs": [
[
"==",
"2.60.1"
]
]
}
],
"lcname": "adxl355-library"
}
JSON
