Package: axR 0.1.2

Lucas França

axR: Serial Communication and Data Retrieval for Axivity Devices

Serial communication and data retrieval for Axivity AX3/AX6 accelerometer devices: device discovery, status, settings, data download, and reading recorded '.cwa'/AX6 binary files. Wraps the Open Movement Project's 'OMAPI' C library (vendored in src/omapi, BSD 2-clause, Newcastle University; see src/omapi/LICENSE.TXT), rather than reimplementing the serial protocol or binary file format directly. On Linux, device discovery requires 'libudev-dev' (Debian/Ubuntu) or 'systemd-devel' (Fedora/RHEL) to be installed separately -- see SystemRequirements. macOS and Windows use OS frameworks/APIs directly, with no separate install step. Part of the Circadia Lab R ecosystem.

Authors:Lucas França [aut, cre], Mario Leocadio-Miguel [aut]

axR_0.1.2.tar.gz
axR_0.1.2.zip(r-4.7)axR_0.1.2.zip(r-4.6)axR_0.1.2.zip(r-4.5)
axR_0.1.2.tgz(r-4.6-x86_64)axR_0.1.2.tgz(r-4.6-arm64)axR_0.1.2.tgz(r-4.5-x86_64)axR_0.1.2.tgz(r-4.5-arm64)
axR_0.1.2.tar.gz(r-4.7-arm64)axR_0.1.2.tar.gz(r-4.7-x86_64)axR_0.1.2.tar.gz(r-4.6-arm64)axR_0.1.2.tar.gz(r-4.6-x86_64)
axR_0.1.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
axR/json (API)

# Install 'axR' in R:

install.packages('axR', repos = c('https://circadia-bio.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/circadia-bio/axr/issues

Pkgdown/docs site:https://axr.circadia-lab.uk

Uses libs:

systemd– Libudev shared library
c++– GNU Standard C++ Library v3

On CRAN:

systemd cpp

2.70 score 31 exports 1 dependencies

Last updated from:893b154bed (on v0.1.2). Checks:11 NOTE, 2 OK. Indexed: yes.

Target	Result	Time
linux-devel-arm64	NOTE	164
linux-devel-x86_64	NOTE	154
source / vignettes	OK	243
linux-release-arm64	NOTE	152
linux-release-x86_64	NOTE	183
macos-release-arm64	NOTE	137
macos-release-x86_64	NOTE	159
macos-oldrel-arm64	NOTE	155
macos-oldrel-x86_64	NOTE	171
windows-devel	NOTE	126
windows-release	NOTE	154
windows-oldrel	NOTE	114
wasm-release	OK	129

Exports:axivity_copy_data axivity_discover axivity_download axivity_download_cancel axivity_download_status axivity_download_wait axivity_enable_debug_log axivity_get_accel_config axivity_get_accelerometer axivity_get_battery axivity_get_data_info axivity_get_delays axivity_get_ecc axivity_get_memory_health axivity_get_metadata axivity_get_session_id axivity_get_time axivity_is_locked axivity_read_cwa axivity_reset axivity_self_test axivity_send_command axivity_set_accel_config axivity_set_delays axivity_set_ecc axivity_set_led axivity_set_lock axivity_set_metadata axivity_set_session_id axivity_set_time axivity_unlock

Dependencies:Rcpp

Getting started with axR

Rendered fromaxR.Rmdusingknitr::rmarkdown

Last update: 2026-07-15
Started: 2026-07-15

Help page	Topics
Copy recorded data directly off a mounted Axivity volume	axivity_copy_data
Discover connected Axivity devices	axivity_discover
Download recorded data off an Axivity device	axivity_download
Cancel an in-progress download from an Axivity device	axivity_download_cancel
Check or wait for an Axivity device's download progress	axivity_download_status axivity_download_wait
Enable OMAPI's internal debug log	axivity_enable_debug_log
Get or set an Axivity device's accelerometer configuration	axivity_get_accel_config axivity_set_accel_config
Read an Axivity device's current accelerometer values	axivity_get_accelerometer
Query an Axivity device's battery level and health	axivity_get_battery
Get information about an Axivity device's recorded data	axivity_get_data_info
Get or set an Axivity device's delayed activation window	axivity_get_delays axivity_set_delays
Get or set an Axivity device's error-correcting code (ECC) flag	axivity_get_ecc axivity_set_ecc
Query an Axivity device's NAND flash memory health	axivity_get_memory_health
Get or set an Axivity device's metadata scratch buffer	axivity_get_metadata axivity_set_metadata
Get or set an Axivity device's session identifier	axivity_get_session_id axivity_set_session_id
Get or set an Axivity device's real-time clock	axivity_get_time axivity_set_time
Check or set an Axivity device's anti-tamper lock	axivity_is_locked axivity_set_lock axivity_unlock
Read a .cwa/AX6 binary file into a tibble	axivity_read_cwa
Erase an Axivity device's data storage and commit settings	axivity_reset
Run an Axivity device's built-in self-test	axivity_self_test
Send a raw command to an Axivity device	axivity_send_command
Set an Axivity device's LED colour	axivity_set_led

Package: axR 0.1.2

axR: Serial Communication and Data Retrieval for Axivity Devices

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)