Support Apnea Board & OSCAR  

Difference between revisions of "Running OSCAR for the first time"

From Apnea Board Wiki
Jump to: navigation, search

(OSCAR Help)
(macOS Ventura 13 users: Updated citations again)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{OSCAR}}
 
{{OSCAR}}
 +
<br />
  
 
==OSCAR Help==
 
==OSCAR Help==
Line 5: Line 6:
  
 
== Creating a Profile ==
 
== Creating a Profile ==
If you have migrated your data from a previous SleepyHead installation, Oscar will automatically migrate your SleepyHead profile(s) as well. (See [http://www.apneaboard.com/wiki/index.php?title=OSCAR_Installation#Migrating_SleepyHead_data Migrating data]). Otherwise when you first open up OSCAR, you will be asked to create a profile. Your data is associated with a profile and you may have multiple profiles and each may have multiple CPAPS associated with it. It is normal to have one profile with all your data associated with that profile.
+
If you have migrated your data from a previous SleepyHead installation, Oscar will automatically migrate your SleepyHead profile(s) as well. (See [http://www.apneaboard.com/wiki/index.php?title=OSCAR_Installation#Migrating_SleepyHead_data Migrating data]). Otherwise when you first open up OSCAR, you will be asked to create a profile.  
 +
 
 +
Your data is associated with a profile and you may have multiple profiles and each may have multiple CPAPS associated with it. However if you have more than one machine (especially if they are different brands), it is recommended that each machine be in its own profile.
  
 
To read more about creating and maintaining profiles, see [[http://www.apneaboard.com/wiki/index.php/OSCAR_Organization_-_Profile_Page OSCAR Profile Page]]
 
To read more about creating and maintaining profiles, see [[http://www.apneaboard.com/wiki/index.php/OSCAR_Organization_-_Profile_Page OSCAR Profile Page]]
  
Once the profile is finished and saved, OSCAR will display a welcome page that looks like this:<br /><br />
+
== Importing Data into OSCAR the FIRST time ==
 
+
Once the profile is finished and saved, OSCAR will display a welcome page that looks like this:<br />
[[File:OSCAR Welcome.PNG | 850 px]]
 
<br />
 
  
 +
[[File:OSCAR Welcome.PNG|thumb|none|850px|OSCAR Welcome page]]<br />
 +
<!--
 
As the page says, it's reasonable to click on Preferences and double check some things first. If you need help, [[#Important preferences settings|jump to 7. Important preference settings]]
 
As the page says, it's reasonable to click on Preferences and double check some things first. If you need help, [[#Important preferences settings|jump to 7. Important preference settings]]
 
+
^^ What the heck does this mean? A newbie won't know what preferences to set
 +
Also where is "7. Important preference settings"?
 +
-->
 
You will see that the options to select statistics, overview or daily view are greyed out until you have loaded (imported) some data into OSCAR.
 
You will see that the options to select statistics, overview or daily view are greyed out until you have loaded (imported) some data into OSCAR.
  
== Changing a Profile Name ==
+
=== macOS Ventura 13 users ===
If for any reason you need to change the name of a profile, it is necessary to edit several of the underlying files and directories (folders). This should only be attempted if you are confident of your computer skills. As there is no built-in procedure for renaming a profile in OSCAR, this manual procedure may be used instead:
+
Apple has added a new security feature to macOS Ventura <ref name="Apple Dev">[https://developer.apple.com/documentation/macos-release-notes/macos-13-release-notes macOS Ventura release notes] Apple Developer Docs, Retrieved 25 Nov 2022 </ref><ref name="Apple Insider">[https://appleinsider.com/inside/macos-ventura/tips/how-to-manage-thunderbolt-usb-security-in-macos-ventura Thunderbolt and USB security in macOS Ventura] Apple Insider, Retrieved 26 Dec 2022 </ref>. This will prevent your Mac from communicating with USB and Thunderbolt devices and will prevent you from importing your SD card data. The setting can be turned off in '''System Settings > Security and Privacy > Security''' <ref name="Apple Dev" /><ref name="Apple Insider />.
 
+
----
NOTE!!  When editing files as instructed below, Always make a backup copy of each file before making any changes.  Also, ALWAYS use a text editor such as Notepad or Xed to make the changes.  DO NOT use a Word Processor program, as the file will likely be corrupted and destroyed.
 
 
 
In this example the original profile is named "Alan", and the new name will be "AlanS9".  To use this example, replace "Alan" and "AlanS9" as needed.
 
 
 
1) Close OSCAR if open.
 
 
 
2) Find the OSCAR data structure.  In this example, it was found in:
 
    /home/alan/Documents/OSCAR_Data.
 
  In Windows or Mac the path location will be different.
 
 
 
3) Edit the file .../OSCAR_Data/Preferences.xml
 
  Change the line:
 
    <Profile type="QString">Alan</Profile>
 
  to read:
 
    <Profile type="QString">AlanS9</Profile>
 
  Save and close the file.
 
 
 
4) Edit the file .../OSCAR_Data/profiles.xml
 
  Change the line:
 
    <profile path="{home}/Profiles/Alan/Profile.xml" name="Alan"/>
 
  to read:
 
    <profile path="{home}/Profiles/AlanS9/Profile.xml" name="AlanS9"/>
 
  Save and close the file.
 
 
 
  Note that this edit may not be required, as there is a comment
 
  in the file that it is not used by Desktop OSCAR.
 
 
 
5) Edit the file .../OSCAR_Data/Profiles/Alan/Profile.xml.
 
  Change the line:
 
    <UserName type="QString">Alan</UserName>
 
  to read:
 
    <UserName type="QString">AlanS9</UserName>
 
  Save and close the file.
 
 
 
6) In .../OSCAR_Data/Profiles, rename the profile directory.
 
  In this case, rename directory "Alan" to "AlanS9".
 
  
7) Open OSCAR, check that the renamed profile is appropriately recognized.
+
Put the SD card into the SD slot if you have not already done that. If your computer does not have an SD slot, you will need to buy a generic SD card reader and put the SD card in that. (If your CPAP machine has a USB stick, any references below to a "SD card" or "SD slot" should be understood to mean "USB stick" or "USB port.")
  All imported data and statistics should appear as expected.
 
  
Special thanks to Apnea Board member becker44a
+
'''WARNING:''' It's wise to make sure the card is locked if you are using a Mac or a Windows 8.1 or Windows 10 machine since these operating systems will write hidden files to unlocked cards. ResMed S9 machines will reject SD cards with any extra files written on them and reformat the card, losing any data on the card. See [[Secure Digital (SD) memory card]] for instructions on locking a card.
  
== Importing Data into OSCAR the FIRST time ==
+
If you are about to import on a Chrome OS system, please read and follow these different instructions [[Mounting your SD Card under Chrome OS]] and then return here.
Put the SD card into the SD slot if you have not already done that. If your computer does not have an SD slot, you will need to buy a generic SD card reader and put the SD card in that.
 
 
 
'''WARNING:''' It's wise to make sure the card is locked if you are using a Mac or a Windows 8.1 or Windows 10 machine since these operating systems will write hidden files to unlocked cards. And the ResMed S9 machines will reject SD cards with any extra files written on them. See [[Secure Digital (SD) memory card]] for instructions on locking a card.
 
  
 
Once the card has been mounted to the computer system, you still need to import the data into OSCAR. There are three different ways to Import the data:
 
Once the card has been mounted to the computer system, you still need to import the data into OSCAR. There are three different ways to Import the data:
Line 73: Line 38:
 
# The Import Data under the File sub-menu. Select this from the standard File menu in the usual way for your system and it starts the import process.
 
# The Import Data under the File sub-menu. Select this from the standard File menu in the usual way for your system and it starts the import process.
 
# The keyboard shortcut. On a Windows machine you can simply press the F2 key and that will start the import process.<br />
 
# The keyboard shortcut. On a Windows machine you can simply press the F2 key and that will start the import process.<br />
 +
  
 
The Import Data menu item and the Import Icons are arrowed in the screen shot below.
 
The Import Data menu item and the Import Icons are arrowed in the screen shot below.
 
<br />
 
<br />
  
[[File:OSCAR Welcome Import.png|850px]]<br /><br /><br />
+
[[File:OSCAR Welcome Import.png||thumb|none|850px|OSCAR SD card data import]]<br />
  
 
With your SD card is in the SD slot or card reader, once you click on Import Data, you will get a small pop up dialog box that looks this:<br />
 
With your SD card is in the SD slot or card reader, once you click on Import Data, you will get a small pop up dialog box that looks this:<br />
  
 +
[[File:CPAP data located.PNG]]<br />
  
[[File:CPAP data located.PNG]]<br />
+
Click "Yes", and the data should load. The "Specify" option allows you to navigate to a different directory, useful if you have copied your SD card to your hard drive. Do not use Specify to navigate to another directory in the SD card. OSCAR relies on finding the directory structure created by the CPAP machine to identify the machine and data.
 
<br />
 
<br />
  
  
Click "Yes", and the data should load. After the initial data import, OSCAR should display your data in a screen that shows the Statistical Data. It looks like this:<br />
+
After the initial data import, OSCAR should display your data in a screen that shows the Statistical Data. It looks like this:<br />
  
[[File:Usage Statistics.PNG|1000px]]<br /><br />
+
[[File:Usage Statistics.PNG||thumb|none|1000px|OSCAR Statistics page]]<br /><br />
  
 
Clicking on the Daily tab in the OSCAR window brings up the Detailed Daily Data for the last day of data:<br />
 
Clicking on the Daily tab in the OSCAR window brings up the Detailed Daily Data for the last day of data:<br />
  
[[File:OSCAR Daily.PNG | 1000 px]]<br /><br />
+
[[File:OSCAR Daily.PNG ||thumb|none|1000px|OSCAR Daily page]]<br /><br />
  
 
Clicking on the Overview tab in the OSCAR window brings up the bar graph data, which provides a summary of the last week, two weeks etc right out to "everything". Note that selecting Everything can take several minutes to generate the chart if you have several years of data.:<br />
 
Clicking on the Overview tab in the OSCAR window brings up the bar graph data, which provides a summary of the last week, two weeks etc right out to "everything". Note that selecting Everything can take several minutes to generate the chart if you have several years of data.:<br />
  
[[File:OSCAR Overview.PNG | 1000 px]]<br />
+
[[File:OSCAR Overview.PNG ||thumb|none|1000px|OSCAR Overview page]]<br />
<br />
 
  
 
== Importing Data into OSCAR AFTER the first time ==
 
== Importing Data into OSCAR AFTER the first time ==
Line 105: Line 71:
 
OSCAR will bring up a list of profiles for you to chose from. For most people, there will only be one name on the profile. Highlight the desired profile and press the Select User button. The data for that profile will load into OSCAR and the Statistics page should load.
 
OSCAR will bring up a list of profiles for you to chose from. For most people, there will only be one name on the profile. Highlight the desired profile and press the Select User button. The data for that profile will load into OSCAR and the Statistics page should load.
  
=== Step 2.  Make sure the SD card is in the SD slot or card reader. ===
+
=== Step 2.  Make sure the SD card is in the SD slot or card reader ===
It's wise to make sure the card is locked if you are using a Mac or a Windows 8.1 machine since these operating systems will write hidden files to unlocked cards. And the ResMed S9 machines will reject SD cards with any extra files written on them.  
+
It's wise to make sure the card is locked if you are using a Mac or a Windows 8.1 (or later) machine since these operating systems will write hidden files to unlocked cards. And the ResMed S9 machines will reject SD cards with any extra files written on them.  
  
 
You will need to have the card in the Write Enabled (unlocked) condition while it is in the S9 and Write Protected (locked) prior to inserting it into your computer.  Also, some of the newer low-cost card readers do not have the micro-switch installed in the unit.  This means that even if you have it write-protected, it may not stop it from having the system files written by the PC.
 
You will need to have the card in the Write Enabled (unlocked) condition while it is in the S9 and Write Protected (locked) prior to inserting it into your computer.  Also, some of the newer low-cost card readers do not have the micro-switch installed in the unit.  This means that even if you have it write-protected, it may not stop it from having the system files written by the PC.
  
To be safe you may wish to download and use the following script. It will turn off(or back on) this feature on your PC. [http://www.apneaboard.com/forums/attachment.php?aid=7621 Prevent SysVol Info Write]
+
To be safe you may wish to download and use the following script. It will turn off(or back on) this feature on your PC. [https://www.sleepfiles.com/temp2c/SysVolWrite.zip Prevent SysVol Info Write]
  
 
=== Step 3. Import the Data ===
 
=== Step 3. Import the Data ===
Line 121: Line 87:
 
2) Remember to properly unmount the SD card from your computer before removing it from the SD slot or card reader. You unmount the SD card the same way you unmount a flash drive or an SD card from a digital camera.
 
2) Remember to properly unmount the SD card from your computer before removing it from the SD slot or card reader. You unmount the SD card the same way you unmount a flash drive or an SD card from a digital camera.
  
3) Remember to put the card back into your CPAP machine. This is particularly true for ResMed users: All the detailed data is written directly to the SD card, and if there is no SD card, that data is lost. And OSCAR will report that there is no data for the night. (ResScan will be able to report on the summary data that is stored in the S9's memory and then written to the card when it is inserted into the machine).
+
3) '''Remember to put the card back into your CPAP machine.''' This is particularly true for ResMed users: All the detailed data is written directly to the SD card, and if there is no SD card, that data is lost. And OSCAR will report that there is no data for the night. (ResScan will be able to report on the summary data that is stored in the S9's memory and then written to the card when it is inserted into the machine).
 +
 
 +
== References ==
 +
<references />

Latest revision as of 04:50, 27 December 2022

Full-48.png

Afrikaans / في الصفحة / български / 中国 / 臺灣 / čeština/ Dansk / Deutsch / Ελληνικά / Español / Filipino / Français / עברית / Magyar / Italiano / 日本語 / 한국어 / Nederlands / Norsk / Polskie / Português / Română / Pусский / Suomalainen / Svenska / ภาษาไทย / Türkçe
--> Do not use these buttons when you are on a translated page. Just close this tab to go back. <--


OSCAR Help

This installation guide is part of the suite of OSCAR help articles. See OSCAR Help.

Creating a Profile

If you have migrated your data from a previous SleepyHead installation, Oscar will automatically migrate your SleepyHead profile(s) as well. (See Migrating data). Otherwise when you first open up OSCAR, you will be asked to create a profile.

Your data is associated with a profile and you may have multiple profiles and each may have multiple CPAPS associated with it. However if you have more than one machine (especially if they are different brands), it is recommended that each machine be in its own profile.

To read more about creating and maintaining profiles, see [OSCAR Profile Page]

Importing Data into OSCAR the FIRST time

Once the profile is finished and saved, OSCAR will display a welcome page that looks like this:

OSCAR Welcome page

You will see that the options to select statistics, overview or daily view are greyed out until you have loaded (imported) some data into OSCAR.

macOS Ventura 13 users

Apple has added a new security feature to macOS Ventura [1][2]. This will prevent your Mac from communicating with USB and Thunderbolt devices and will prevent you from importing your SD card data. The setting can be turned off in System Settings > Security and Privacy > Security [1][2].


Put the SD card into the SD slot if you have not already done that. If your computer does not have an SD slot, you will need to buy a generic SD card reader and put the SD card in that. (If your CPAP machine has a USB stick, any references below to a "SD card" or "SD slot" should be understood to mean "USB stick" or "USB port.")

WARNING: It's wise to make sure the card is locked if you are using a Mac or a Windows 8.1 or Windows 10 machine since these operating systems will write hidden files to unlocked cards. ResMed S9 machines will reject SD cards with any extra files written on them and reformat the card, losing any data on the card. See Secure Digital (SD) memory card for instructions on locking a card.

If you are about to import on a Chrome OS system, please read and follow these different instructions Mounting your SD Card under Chrome OS and then return here.

Once the card has been mounted to the computer system, you still need to import the data into OSCAR. There are three different ways to Import the data:

  1. The Import Icons on the main window and the sidebar. Click either of these and it starts the import process.
  2. The Import Data under the File sub-menu. Select this from the standard File menu in the usual way for your system and it starts the import process.
  3. The keyboard shortcut. On a Windows machine you can simply press the F2 key and that will start the import process.


The Import Data menu item and the Import Icons are arrowed in the screen shot below.

OSCAR SD card data import

With your SD card is in the SD slot or card reader, once you click on Import Data, you will get a small pop up dialog box that looks this:

CPAP data located.PNG

Click "Yes", and the data should load. The "Specify" option allows you to navigate to a different directory, useful if you have copied your SD card to your hard drive. Do not use Specify to navigate to another directory in the SD card. OSCAR relies on finding the directory structure created by the CPAP machine to identify the machine and data.


After the initial data import, OSCAR should display your data in a screen that shows the Statistical Data. It looks like this:

OSCAR Statistics page


Clicking on the Daily tab in the OSCAR window brings up the Detailed Daily Data for the last day of data:

OSCAR Daily page


Clicking on the Overview tab in the OSCAR window brings up the bar graph data, which provides a summary of the last week, two weeks etc right out to "everything". Note that selecting Everything can take several minutes to generate the chart if you have several years of data.:

OSCAR Overview page

Importing Data into OSCAR AFTER the first time

Each time you want to import data into OSCAR you go through the same basic process, except you don't have to create the profile:

Step 1. Open OSCAR

OSCAR will bring up a list of profiles for you to chose from. For most people, there will only be one name on the profile. Highlight the desired profile and press the Select User button. The data for that profile will load into OSCAR and the Statistics page should load.

Step 2. Make sure the SD card is in the SD slot or card reader

It's wise to make sure the card is locked if you are using a Mac or a Windows 8.1 (or later) machine since these operating systems will write hidden files to unlocked cards. And the ResMed S9 machines will reject SD cards with any extra files written on them.

You will need to have the card in the Write Enabled (unlocked) condition while it is in the S9 and Write Protected (locked) prior to inserting it into your computer. Also, some of the newer low-cost card readers do not have the micro-switch installed in the unit. This means that even if you have it write-protected, it may not stop it from having the system files written by the PC.

To be safe you may wish to download and use the following script. It will turn off(or back on) this feature on your PC. Prevent SysVol Info Write

Step 3. Import the Data

Once OSCAR loads the data for the selected Profile and the SD card is mounted, you can import the (new) data by either pressing the Import icon, using the File menu to select Import Data, or the keyboard shortcut---pressing the F2 key. The Import dialog box will appear and if you are importing from the After the first data importation, you can import the data regardless of which data view you are looking at. If you import data while in the Daily Data view, the Daily Data will jump to the last day of imported data after the data is successfully imported.

Additional Notes

1) The process for importing the data is easy once you get used to it.

2) Remember to properly unmount the SD card from your computer before removing it from the SD slot or card reader. You unmount the SD card the same way you unmount a flash drive or an SD card from a digital camera.

3) Remember to put the card back into your CPAP machine. This is particularly true for ResMed users: All the detailed data is written directly to the SD card, and if there is no SD card, that data is lost. And OSCAR will report that there is no data for the night. (ResScan will be able to report on the summary data that is stored in the S9's memory and then written to the card when it is inserted into the machine).

References

  1. 1.0 1.1 macOS Ventura release notes Apple Developer Docs, Retrieved 25 Nov 2022
  2. 2.0 2.1 Thunderbolt and USB security in macOS Ventura Apple Insider, Retrieved 26 Dec 2022



Donate to Apnea Board