Skip to main content

pyOpenSci status PyPI version PyPI pyversions Actions Status: test Coverage Badge DOI Project Status: Active – The project has reached a stable, usable state and is being actively developed. Binder

Devicely Logo

Devicely is a Python package for reading, de-identifying and writing data from various health monitoring sensors. With devicely, you can read sensor data and have it easily accessible in dataframes. You can also de-identify data and write them back using their original data format. This makes it convenient to share sensor data with other researchers while mantaining people's privacy.

Documentation

PyPi

Conda-forge

Installation

PyPi (current release)

Installing devicely is as easy as executing:

pip install devicely

Conda-forge (current release)

To install devicelythrough conda-forge:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, devicely can be installed with:

conda install devicely

List all of the versions of devicely available on your platform with:

conda search devicely --channel conda-forge

Locally (development version)

git clone git@github.com:hpi-dhc/devicely.git
cd devicely
pip install .

Sneak Peek

All devices contain the following methods as exemplified through the EmpaticaReader:

empatica_reader = devicely.EmpaticaReader(path_to_empatica_files)
empatica_reader.timeshift()
empatica_reader.write(path_to_write_files)

You can also try this notebook with examples and sample data or check our binder:

Binder

Quick Start

To get started quickly, follow our quick-start guide.

Or check the full documentation: https://hpi-dhc.github.io/devicely/

Supported Sensors

  • Empatica E4 is a wearable device that offers real-time physiological data acquisition such as blood volume pulse, electrodermal activity (EDA), heart rate, interbeat intervals, 3-axis acceleration and skin temperature.

  • Biovotion Everion is a wearable device used for the continuous monitoring of vital signs. Currently, it measures the following vital signs: heart rate, blood pulse wave, heart rate variability, activity, SPO2, blood perfusion, respiration rate, steps, energy expenditure, skin temperature, EDA / galvanic skin response (GSR), barometric pressure and sleep.

  • 1-lead ECG monitor FarosTM 180 from Bittium is a one channel ECG monitor with sampling frequency up to 1000 Hz and a 3D acceleration sampling up to 100Hz.

  • Spacelabs (SL 90217) is an oscillometric blood pressure (BP) monitor which can be used to automatically track a person's BP in specificed time intervals.

  • TimeStamp for Android allows you to record the timestamp of an event at the time it occurs. It also allows you to create specific tags such as "Running" or "Walking" and timestamp those specific activities.

  • Shimmer Consensys GSR is a device that is used to collect sensor data in real time and it contains sensors such as GSR / EDA, photoplethysmography (PPG), 3-axis accelerometer, 3-axis gyroscope, 3-axis magnetometer & integrated altimeter.

  • Muse S headband is a consumer grade headband consisting of 4 electrodes electroencephalography (EEG) sensors, 3-axis accelerometer (ACC), gyroscope, and photoplethysmography (PPG) sensors.

How to Contribute

If you want to be part of this mission, please check our documentation on how to contribute here.

Authors

* Ariane Sasso
* Jost Morgenstern
* Felix Musmann
* Bert Arnrich

Contributors

* Arpita Kappattanavar
* Bjarne Pfitzner
* Lin Zhou
* Pascal Hecker
* Philipp Hildebrandt
* Sidratul Moontaha

Metadata

Release files for devicely 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for devicely 1.1.1
File Size Uploaded Provenance
devicely-1.1.1.tar.gz 18.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for devicely 1.1.1
File Interpreter ABI Platform
devicely-1.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 39.5 kB

Release files / devicely-1.1.1.tar.gz

Download URL devicely-1.1.1.tar.gz
Size 18.4 kB
Tags Source
SHA-256 checksum
How to use checksums
542983ecd3aed8b07f3c04ee953733fc3ac2aaf4e74f1ce034b789ada5bfc7bd
BLAKE2b-256 checksum
How to use checksums
9fc483d41db0e587a8723b0d90ad6c264ca0e9880320a82ed696249f44a3020d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Release files / devicely-1.1.1-py3-none-any.whl

Download URL devicely-1.1.1-py3-none-any.whl
Size 21.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
78434962f4a5e9bf47a399bc2413860965f8bb204818f837763dfb2006b3b7eb
BLAKE2b-256 checksum
How to use checksums
07cb3d2be1b80de6bdf238586c2ad20efc324fc0161d427b87b390b8fb075744
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

Security for devicely 1.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page