https://github.com/pcboy/cpapshare
Tired of the daily CPAP SD card shuffle between machine and computer? This project uses a single-board computer to create a simple data transfer station right next to your CPAP. No more forgotten SD cards! 🌙
https://github.com/pcboy/cpapshare
Last synced: 20 days ago
JSON representation
Tired of the daily CPAP SD card shuffle between machine and computer? This project uses a single-board computer to create a simple data transfer station right next to your CPAP. No more forgotten SD cards! 🌙
- Host: GitHub
- URL: https://github.com/pcboy/cpapshare
- Owner: pcboy
- License: unlicense
- Created: 2025-01-11T11:58:32.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-11T13:10:12.000Z (over 1 year ago)
- Last Synced: 2025-01-11T13:42:28.538Z (over 1 year ago)
- Language: Ruby
- Size: 1.04 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CPAPShare
## The Problem
You know that daily routine? Take out the SD card from the CPAP, check the results on [OSCAR](https://www.sleepfiles.com/OSCAR/), and then... oops, forgot to put it back in the machine. Every. Single. Time.
I tried finding a better way - like using wifi SD cards (EZShare), but no luck with my CPAP (Lowenstein Prisma Smart). Seems like the CPAP doesn't provide enough juice to power them properly.
## My "Good Enough" Solution
Instead of fancy expensive hardware, here's what I came up with:
1. Put a small single-board computer (like an Orange Pi Zero 2W) next to the CPAP
2. In the morning, quickly swap the SD card from CPAP to the board
3. Let it automatically backup the data somewhere I can access from my desktop
4. Done!
Sure, there are fancier solutions like SD card muxers (like the [USB-SD-Mux](https://linux-automation.com/en/products/usb-sd-mux-fast.html)), but they're expensive and probably overkill. Plus, who knows if they'd even work with a CPAP?
## Table of Contents
- [CPAPShare](#cpapshare)
- [The Problem](#the-problem)
- [My "Good Enough" Solution](#my-good-enough-solution)
- [Table of Contents](#table-of-contents)
- [Hardware Requirements](#hardware-requirements)
- [Flow](#flow)
- [Setting Things Up](#setting-things-up)
- [Auto Start on boot (SystemD service)](#auto-start-on-boot-systemd-service)
- [Callback on backup completion](#callback-on-backup-completion)
- [Configuration (optional)](#configuration-optional)
- [Configuration Options](#configuration-options)
- [`copy_type`](#copy_type)
- [`exclude`](#exclude)
- [Troubleshooting](#troubleshooting)
- [Syncing to Your Computer](#syncing-to-your-computer)
- [Final setup](#final-setup)
## Hardware Requirements
- [Orange Pi Zero 2W 1GB](https://www.aliexpress.com/item/1005005979335218.html) (or any Linux-capable single-board computer)
- A USB SD card reader (I use [Vava USB-C hub](https://www.vava.com/products/vava-hub-p8-ii))
- MicroSD card for the Orange Pi (I recommend [SanDisk Ultra A1 SDSQUAB-064G-GH3MA](https://www.amazon.co.jp/dp/B0CH2XQN3P))
## Flow
```mermaid
sequenceDiagram
actor User
participant CPAP
participant SDCard
participant OrangePi
participant Phone
participant Desktop
User->>CPAP: Remove SD Card
User->>OrangePi: Insert SD Card
Note over OrangePi: udisks2 detects
new device
activate OrangePi
OrangePi->>SDCard: Mount device
OrangePi->>OrangePi: Copy data to ~/cpapshare-data/
OrangePi->>Phone: Send completion notification
(via post_backup.sh)
deactivate OrangePi
User->>SDCard: Remove SD Card
User->>CPAP: Insert SD Card back
Desktop->>OrangePi: Sync data from ~/cpapshare-data/ (syncthing)
Note over Desktop: Analyze data
with OSCAR
```
## Setting Things Up
1. Flash [Armbian](https://www.armbian.com/) to your Orange Pi's MicroSD card
2. Edit `/root/.not_logged_in_yet`. ([see Armbian docs](https://docs.armbian.com/User-Guide_Autoconfig/#sample-config-file)) (Username must be 'armbian'.)
3. SSH into the device: `ssh armbian@YOUR_DEVICE_IP`
4. Update system:
```shell
sudo apt update && sudo apt full-upgrade --yes && sudo reboot
```
5. install the dependencies:
```shell
sudo apt install curl git udisks2 policykit-1-gnome ruby ruby-dbus ruby-optimist
```
6. Clone this repository with:
```shell
git clone https://github.com/pcboy/cpapshare ~/cpapshare
```
7. If you can't mount devices as user `armbian`, that means you are missing the polkit policy. In that case do:
```shell
sudo ./cpapshare.rb --install
```
This adds a polkit config allowing members of the `sudo` group to mount devices.
## Auto Start on boot (SystemD service)
The project includes a SystemD service file ([cpapshare.service](./cpapshare.service)). To enable it:
```shell
sudo cp cpapshare.service /etc/systemd/system/cpapshare.service
sudo systemctl enable --now cpapshare.service
```
## Callback on backup completion
The `cpapshare.rb` also has a mechanism to trigger some callback script after the backup is done. You simply need to have a file `post_backup.sh` in the same directory as the cpapshare.rb file.
Check example [post_backup.example.sh](./post_backup.example.sh), I'm using it to send a notification to [ntfy.sh](http://ntfy.sh), so I get notified on my phone when the backup is done. Make sure the script is executable.
## Configuration (optional)
CPAPShare can be configured using a `config.json` file located at `~/.config/cpapshare/config.json`. The configuration is reloaded automatically each time an SD card is inserted, so no service restart is needed when changing settings.
If the file does not exist, the script will use default settings (`{copy_type: "raw"}`).
### Configuration Options
You can for instance create a `config.json` file with the following options:
```json
{
"copy_type": "raw",
"exclude": ["System Volume Information"]
}
```
#### `copy_type`
Controls how files are copied from the SD card:
- **`"raw"`** (default): Copies all files and directories from the SD card directly to `~/cpapshare-data/`
- **`"dates"`**: (ResMed machines only) Looks for a `DATALOG` directory, identifies _new_ date folders (based on the latest backup in `~/cpapshare-data/`), and creates a new backup directory named `first_new_date_last_new_date` (e.g., `2025-08-27_2025-08-31`). This new directory will contain only the new date folders and a complete copy of the rest of the SD card. This is useful for services like SleepHQ that require a full SD card backup but you only want to upload the new data.
#### `exclude`
An array of strings representing file or directory paths that should be excluded from the backup. The paths are relative to the root of the SD card. This option works with both `raw` and `dates` copy types. The strings are treated as **glob patterns**.
Examples:
- `"System Volume Information"` - excludes a specific directory
- `"*.log"` - excludes all files with the .log extension
- `"config.ini"` - excludes a specific file
## Troubleshooting
You can view logs with `sudo journalctl -u cpapshare.service -f`
## Syncing to Your Computer
I recommend using Syncthing - it's perfect for sharing the backup folder with your desktop:
1. Install it from https://apt.syncthing.net/
2. Enable and start it:
```shell
systemctl enable syncthing@armbian.service && systemctl start syncthing@armbian.service
```
3. Access the web interface at `http://ORANGE_IP:8384`
- If you can't access it, edit `/home/armbian/.local/state/syncthing/config.xml` to change listen address from `127.0.0.1` to `0.0.0.0`
4. Share the ~/cpapshare-data folder from the Opi and you are good to go.
Then in OSCAR, you just import data from your synced folder, and I recommend to set in OSCAR's preferences the `Import without asking for confirmation` on the `Import tab`. Then each time you open OSCAR it will just automatically import latest available data from the synced folder.
## Final setup
Here's how I have it set up: Orange Pi Zero 2W stuck to my bedside table with [double-sided magic tape](https://www.amazon.co.jp/-/en/Repeatedly-Removable-Waterproof-Multifunctional-Industrial/dp/B07ZFCHR8X) (orange box on the left), and the SD card reader on the right.
I 3D printed the Opi5 box from this model: https://www.printables.com/model/1124421-orange-pi-zero-2w-case
