Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/umer0586/sensagram
Stream real-time Android sensor data over UDP with low-latency
https://github.com/umer0586/sensagram
accelerometer accelerometer-and-gyroscope android android-app android-application android-sensors gyroscope imu iot motion-sensors sensor-data sensor-fusion sensor-streaming sensors sensors-data-collection sensors-readings udp udp-client udp-protocol
Last synced: 3 months ago
JSON representation
Stream real-time Android sensor data over UDP with low-latency
- Host: GitHub
- URL: https://github.com/umer0586/sensagram
- Owner: umer0586
- License: gpl-3.0
- Created: 2024-10-07T10:57:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T17:11:53.000Z (3 months ago)
- Last Synced: 2024-10-22T05:58:30.382Z (3 months ago)
- Topics: accelerometer, accelerometer-and-gyroscope, android, android-app, android-application, android-sensors, gyroscope, imu, iot, motion-sensors, sensor-data, sensor-fusion, sensor-streaming, sensors, sensors-data-collection, sensors-readings, udp, udp-client, udp-protocol
- Language: Kotlin
- Homepage:
- Size: 438 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SensaGram
    
#### Stream real-time Android sensor data using [UDP (User Datagram Protocol)](https://en.wikipedia.org/wiki/User_Datagram_Protocol), a connectionless transport layer protocol designed for low-latency, fast data transmission without establishing a persistent connection.
## Usage
In the app, select the desired sensors from the list and tap the "Stream" button. This will begin transmitting sensor data to the specified address. To receive the data, you'll need to set up a UDP server. The app sends the data in JSON format.
Note : _**You can dynamically control the data stream by selecting or deselecting sensors from the list during active streaming.This allows for flexible management of sensor data transmission.**_
```json
{
"type": "android.sensor.accelerometer",
"timestamp": 3925657519043709,
"values": [0.31892395,-0.97802734,10.049896]
}
```
where
| Array Item | Description |
| ------------- | ------------- |
| values[0] | Acceleration force along the x axis (including gravity) |
| values[1] | Acceleration force along the y axis (including gravity) |
| values[2] | Acceleration force along the z axis (including gravity) |
And [timestamp](https://developer.android.com/reference/android/hardware/SensorEvent#timestamp) is the time in nanoseconds at which the event happened
Use `JSON` parser to get these individual values.
**Note** : *Refer to the following official Android documentation links to understand what each value in the **values** array represents.*
- For motion sensors [/topics/sensors/sensors_motion](https://developer.android.com/guide/topics/sensors/sensors_motion)
- For position sensors [/topics/sensors/sensors_position](https://developer.android.com/guide/topics/sensors/sensors_position)
- For Environmental sensors [/topics/sensors/sensors_environment](https://developer.android.com/guide/topics/sensors/sensors_environment)
## Python example
The following Python code allows you to receive sensor data from the Sensagram app. The server will listen on all available network interfaces, which is indicated by the address `0.0.0.0`. To set up the server, follow these steps:
#### 1. Clone the Gist repository:
see : [udpserver.py](https://gist.github.com/umer0586/1331ac524c525bae7b1c94667ed571de)
```bash
git clone https://gist.github.com/umer0586/1331ac524c525bae7b1c94667ed571de example
cd example
```
#### 2. Create a Python file (e.g., server.py) in the example directory and add the following code:
```python
from udpserver import UDPServer
import json
def onData(data):
jsonData = json.loads(data)
sensorType = jsonData["type"]
timestamp = jsonData.get("timestamp")
values = jsonData.get("values")
if sensorType == "android.sensor.accelerometer":
x, y, z = values
print(f"accelerometer : x = {x}, y = {y}, z = {z} timestamp = {timestamp} ")
if sensorType == "android.sensor.gyroscope":
x, y, z = values
print(f"gyroscope : x = {x}, y = {y}, z = {z} timestamp = {timestamp} ")
if sensorType == "android.gps":
print(jsonData)
# Initialize the server to listen on all network interfaces (0.0.0.0) and port 8080
server = UDPServer(address=("0.0.0.0", 8080))
server.setDataCallBack(onData)
server.start()
```
#### 3 Run the script on the machine you want to receive data on:
```bash
python server.py
```
#### 4. Configure the Sensagram app:
In the app's settings, enter the IP address of the machine running this script. To find your machines's IP address:
- On **Windows**, use the `ipconfig` command.
- On **Linux**, use the `ifconfig` command.
## Stream On Boot
The app can stream sensor data to a specified address upon device boot. For devices running Android 9 or lower, the app automatically enables Wi-Fi on boot and starts the data stream. However, for devices running Android 10 and later, apps cannot directly control Wi-Fi settings. Therefore, you need to ensure your device's Wi-Fi is enabled before shutting down or restarting. This allows the system to automatically restore the Wi-Fi state when the device boots up. Additionally, make sure the app is not restricted from performing background activities, which you can adjust through your device's system settings.
### Video Demo
A demonstration of Sensagram's sensor data streaming capabilities via UDP, utilizing a Python script within Blender to map phone orientation and dynamically control the rotation of a 3D object. See [rotate.py](https://gist.github.com/a5b1247b1999848fe16dda340335dfe6.git)
[](https://www.youtube.com/watch?v=IxHCX9Im31A)
## Installation
[
](https://f-droid.org/packages/com.github.umer0586.sensagram/)
OR
Download apk from [release](https://github.com/umer0586/SensaGram/releases) section.