This repository contains the SaraKIT library, a SWIG-generated interface that allows Python users to access and control the functionalities of SaraKIT devices originally written in C++.
swig/devices.hpp: The main header file for the C++ library.swig/devices.cpp: The main file for the C++ library.swig/SaraKITDevices_wrap.c: The SWIG-generated C++ source file for interfacing with Python.swig/sarakitdevices.py: The Python module generated by SWIG.swig/SaraKITDevices.i: SWIG file.swig/make_so.sh: Script for building Python library.examples/: Directory containing sample Python scripts demonstrating the use of the SaraKIT library.
SaraKIT-AS5048A-AS5600-encoder-Raspberry-Pi: a simple example displaying data from an AS5048A or AS5600 encoderSaraKIT-LSM6DS3TR-Accelerometer-Gyroscope-Temperature-Raspberry-Pi: a simple example displaying Temperature, data from Accelerometer and GyroscopeSaraKIT-LIS3DH-Accelerometer-Raspberry-Pi: a simple example displaying data from Accelerometer (on Mainboard)SaraKIT-BLDC-Gimbal-Motor-FOC-Raspberry-Pi: simple demonstration of turning a BLDC motor with or without an encoderSaraKIT-Audio- Audio Examples: AudioVolume.py, ShowPowerMeter.py, SoundLocator.py (https://sarakit.saraai.com/getting-started/audio)
Ensure you have the following installed on your system:
- Python 3.x
- getting starter software: https://sarakit.saraai.com/getting-started/software
-
Clone the repository:
git clone https://github.com/SaraEye/SaraKIT-Python-Examples.git
-
Navigate to the cloned directory:
cd SaraKIT-Python-Examples
After installation, you can import the SaraKIT module in your Python scripts:
import sarakitdevices as skRefer to the examples in the main directory to get started with using the library.
Contributions to the SaraKIT Python library are welcome. Please refer to the CONTRIBUTING.md file for guidelines.
This library is licensed under the MIT License.
For any queries or suggestions, please open an issue in this repository.