SleepyHead Users Guide

From SleepyHead Wiki
Jump to: navigation, search

Getting Started

Installation

Windows

Currently there is not installer, so installing is a matter of unzipping the downloaded package, and running the SleepyHead.exe executable.

Make sure all the DLL's are in there with the executable. (If you don't see any, you downloaded the update by mistake)

Mac

Open the DMG file, drag and drop the SleepyHead app onto the Applications folder, close the DMG folder, and eject the DMG volume on your Desktop.

Creating the Initial Profile

Importing Data

To do anything useful with SleepyHead, your going to need to import some data.

Click on File->Import menu or the Import button to open the import dialog.

File:ImportDialog.png

Select the appropriate folder and click Import to start the process. The first import may take a while, especially if you have lots of data.

After this, SleepyHead will only import any new data, so next time around it will be much quicker.

Mac Users

It pays to write-protect your SD card with the plastic tab before inserting into your Mac.

The reason is OSX tries to write an index file/thumbnail cache (.DS_Store) without asking. This can totally screw up the SD cards file tables, as some CPAP machines don't fully implement the Fat16/32 disk standards.

Remember to unlock it afterwards. (Your CPAP machine should warn you if you forget)

SD Cards

Select the ROOT of the SD card folder (not any of the contents.) On windows, this will be the drive letter of the SD card.

ImportDialogWindowsSD.jpg

SleepyHead scans the SD card and needs to see the folder structure, to take a guess at what data it contains.

From a backup copy

Because of the way SleepyHead scans for content, you can make copies of your SD card to your hard drive..

SleepyHead can import from these backup folders without problems. It won't double up data internally if you have multiple copies..

Welcome Page

This will eventually be a help browser.. It is based on WebKit, so it is internet capable.. I wouldn't recommend using it as one though.

WelcomeScreen.png

Daily View

Consists of a nav panel, calendar, a details pane, and the main graph area.

DailyView.png

Navigation

Nav Panel

The navigation panel is directly above the calendar, the the left panel.

DailyViewNav.png

You can hide/show the calendar by clicking on the button displaying the date above it.

The green arrows on each side of this panel will move one day forward or back. (There is a preferences option to skip over empty days)

The >| button will jump to the day with the newest data record.

Calendar

The calendar is very simple.. Simply click on a highlighted (bold) day to show it's data.

The two arrows allow you to move back and forth one month at a time.

DailyViewCal.png

Colour Coding

  • Days with CPAP data will highlight in blue
  • Days with a note will highlight in black.
  • Days with both CPAP and Oximetry data will highlight in red.

Tab Areas

Details Tab

The details tab shows a summary of the entire days data, based on what type of machine data that's available.

DailyViewDetailsTab.png

Events Tab

The Events tab allows you to step through the events tree, highlighting a 4 minute window around individual events.

DailyViewEventsTab.png

The number in (brackets) after individual events is used for alignment purposes, to make the events match up to the flow rate waveform.

It may or may not be related to duration, so I left it in, in the hopes someone else might figure it out.

Notes Tab

The notes tab allows you to keep a sleep journal or whatever.

File:DailyViewNotesTab.png

It will automatically save your notes when you move to the next day..

Daily View Graphs

Event Flags

The event flags is the main "control" graph, it represents a time-line of the event data available for a day.

This graph does not zoom, instead it highlights the selected area, allowing for quicker control/zooming around graphs.

DailyViewEventFlagsGraph.png

Each individual flag represents one event, although they can sometimes pack very tightly together and appear to join up.

PB/CSR Events (for machines that support this) represent a Span of time.

Flow Rate Waveform

The flow rate waveform shows the recorded breathing patterns, with the individual event flags overlayed on top.

DailyViewFlowRateGraph.png

Notes This graph is only visible when the data is available.

  • ResMed S9 machines (stupidly) delete this data when it's older than 7 days. Back up your SD card regularly!
  • Philips Respironics "System One" machines will not recover flow data if the SD card is left out accidentally.

Overview Page

OverviewExample.png

Oximetry

Oximetry is still a work in progress.

Currently SleepyHead supports three methods of importing Contec CMS50X data.

  • Importing from SpO2Review Software
  • Importing direct from CMS50 internal recordings via Serial cable
  • Recording live via serial cable directly from the device.

The latter two are used via the Oximetry tab.

Importing SpO2Review Data

This method requires finding the SpO2Review softwares data store directory.

The windows SpO2Review software uses the .spoR file format.

Oximetry Tab

The oximetry tab allows USB serial importing off the CMS50 device.

Note: The feature is currently a little cantankerous, and needs extra work.

OximetryScreenshot.png

Importing via Serial Cable

This module has been rewritten, and is functioning much better now.

It still needs more testing for CMS50E and up..

Put the device into the right mode (eg, the menu on the cms50D+) before clicking import, otherwise it will fail.

Live View

Live view requires constant connection to the USB cable (or the fancy wireless interface.)

It also adds the ability to record a basic plethysomogram, along with the Pulse and SpO2 data.

Mouse Control

[ this section should probably disperse among the page overviews above ]

Left or Right clicking inside a charts main area will zoom in or out.

Clicking and holding down the Right mouse button and dragging left or right (while zoomed in) will move the selected area about.

Clicking and holding the Left button down in the main graph area, will allow you to select a range to zoom in to.

Daily View

Right click and dragging in the Event Flags chart (which represents the whole area), will cause the highlighted area to follow the mouse cursor. If fully zoomed out, it will zoom in and centre on an half-hour area first. Doing this on any other another chart works similar, but pans as if the graph was being picked up and dropped.

Left click and dragging left or right will highlight and select the area you choose. Doing this on the Event flags graph allows selection from the entire day's data area.

Single Left clicking will centre the current highlighted area. If the mouse cursor is already centred, it will zoom in a step instead.

A single right click will also centre the current highlighted area.. But it will zoom out a step if already centred..


Overview

Hovering over a summary chart will popup a tooltip, containing information relevant for that chart on that day.

Shift+Left Clicking will jump to the daily view with that date selected.

Oximetry

Nothing really special yet..


Preferences