Support Apnea Board & OSCAR  

Difference between revisions of "OSCAR Installation"

From Apnea Board Wiki
Jump to: navigation, search

(→‎Linux version)
(removing translate template from page, since {{OSCAR}} template now includes the {{translate}} template as well)
 
(48 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
{{OSCAR}}
 
{{OSCAR}}
 +
<br />
 +
==OSCAR Help==
 +
This installation guide is part of the suite of OSCAR help articles. See [[OSCAR Help]].
  
−
<br />
+
==OSCAR installation process==
 +
Installing OSCAR requires only a few steps:
 +
# Download the OSCAR installer for your computer from [https://www.sleepfiles.com/OSCAR/ the official download page].
 +
# Install OSCAR. This process differs for each type of computer, [[#Download and install|see below]] for details.
 +
# Run OSCAR and select where you want OSCAR to save your data when it asks you. You can simply accept its recommendation.
 +
## '''Note:''' Do not select the SD card itself as the destination. Select a location on your PC hard drive (or just accept the recommendation).
 +
# If you've been using SleepyHead, [[#Migrating or copying SleepyHead data|see below]] for how to migrate your previous SleepyHead data. Otherwise, see "[[Running OSCAR for the first time]]" to set up a new profile and import the data from your machine.
  
−
==Download page==
+
==Download and install==
−
OSCAR is available at the official download page: '''https://sleepfiles.com/OSCAR/'''
+
OSCAR is available at the official download page: '''https://www.sleepfiles.com/OSCAR/'''
  
−
There are OSCAR versions available for Windows, Apple Mac and Linux.
+
There are OSCAR versions available for Windows, Apple Mac and Linux. Detailed instructions may be found at the following links:
 +
* [[OSCAR Installation: Windows]]
 +
* [[OSCAR Installation: Apple Mac]]
 +
* [[OSCAR Installation: Linux]]
 +
* [[OSCAR Installation: Chrome OS]]
  
 
You may also read the page in a number of different languages - the list of languages is along the top of the page.
 
You may also read the page in a number of different languages - the list of languages is along the top of the page.
Line 12: Line 25:
 
OSCAR is open source software, and there are links to the source code near the bottom of the page. Note that this is for software developers - the great majority of users don't need to worry about the source code.
 
OSCAR is open source software, and there are links to the source code near the bottom of the page. Note that this is for software developers - the great majority of users don't need to worry about the source code.
  
−
==Windows version==
+
== OSCAR data folder ==
−
 
+
OSCAR needs to set up a folder to store your data in. Click '''OK''' to accept the recommended folder or '''No''' to select an alternative folder. '''Note:''' Do not select the SD card itself as the destination. Select a location on your PC hard drive (or just accept the recommendation).<br /><br />
−
===32 bit or 64 bit===
 
−
The Windows version of OSCAR is available as both 32 bit and 64 bit. In general the 32 bit version will work on all computers using Windows 7, 8 or 10. The 64 bit version is for "power users" running a 64 bit operating system. If in doubt, select the 32 bit version.
 
−
 
 
−
===Download process===
 
−
* In page https://sleepfiles.com/OSCAR/ click the link for Windows 32 bit or 64 bit download.
 
−
* The installation file will now download to your computer
 
−
** '''Important:''' Some web browsers (eg Chrome) may give you a warning that the downloaded file is unsafe and may damage your computer. Provided you have downloaded Oscar from the link above you can safely ignore this warning and select "Keep file". Browsers other than Chrome (eg Edge, Firefox) may use a different format, but the concept is the same.
 
−
* The usual (default) location for a downloaded file is '''My Downloads''' or '''C:\user\xxx\downloads''' where the xxx is replaced by your name (eg C:\user\bill\downloads)
 
−
** You may have set your computer so that the default is in a different location.
 
−
* Navigate to the download folder and identify the OSCAR installation file. It will have a name similar to, not not necessarily exactly the same as '''OSCAR-v1.0.0-Win32.exe'''
 
−
** Double-click on this file to commence installation.
 
−
 
 
−
===Virus protection===
 
−
 
 
−
Because OSCAR is a new product and is not published by one of the big software companies, Windows and the various anti-virus programs may see it as a dangerous program or virus. Provided you have obtained OSCAR from the official download page, it is quite safe and these warnings can be ignored.
 
−
 
 
−
Windows may attempt to block the execution of this program. You will see a popup window saying "Windows protected your PC".
 
−
 
 
−
[[File:Windows Protection 1.png]] 
 
−
 
 
−
 
 
−
Click on the "'''More info'''" button, and an option to "Run anyway" will appear. Click on this option.
 
−
 
 
−
 
 
−
[[File:Windows Protection 2.png]]
 
−
 
 
−
 
 
−
At this point your anti-virus software may also block execution. Again you will need to select the option to run the file anyway - the exact details will vary considerably depending on which type of anti-virus software you have.
 
−
 
 
−
[[File:Virus Protection.png]]
 
−
 
 
−
===Installation===
 
−
Once you have got through the protection screens, OSCAR will continue its installation process. A series of information screens and dialog boxes will guide you through the process. In all cases, just select "OK" unless you have a specific reason not to.
 
−
 
 
−
* '''Setup Language''' defaults to English, but you can select one of the other supported languages if you prefer.
 
−
* '''Destination Location''' defaults to C:\Program Files\OSCAR for the 64 bit version and C:\Program Files (x86)\OSCAR for the 32 bit. You can just accept this or browse for an alternative location if you prefer. (Generally it's better to accept the default).
 
−
* '''Start Menu Folder''' sets the location where Windows will place the shortcut to run OSCAR. Accept the default.
 
−
* '''Additional tasks''' OSCAR will offer to place a shortcut icon on your desktop. Most users will accept this. You can de-select this option if you prefer.
 
−
* '''Ready to Install'''  gives a summary of the selections you have made. Click on '''Install''' to complete the installation or '''<Back''' to go back and make any changes.
 
−
* '''Completing the OSCAR Setup Wizard''' OSCAR is now installed and ready to go. You can chose to launch OSCAR immediately.
 
−
 
 
−
==Apple Mac version==
 
−
=== Installation ===
 
−
# Open the OSCAR.dmg file that you downloaded. You will see a Finder window with the OSCAR application: [[File:Oscar-mac-1-oscar-dmg-open.png|center]]
 
−
# To install OSCAR, you need to copy it to the Applications folder on your computer.  To do so:
 
−
## <span id="Mac Applications Folder"></span>Open the Applications folder in Finder by selecting the "Go" menu and then "Applications": [[File:Oscar-mac-2-open-applications-folder.png|center]] [[File:Oscar-mac-3-opened-applications-folder.png|center]]
 
−
## Arrange the windows so that you can see the OSCAR icon and the Applications folder, as shown below.
 
−
## Click on the OSCAR icon and drag it into the Applications window. Note the green "+" cursor indicating that it will be copied to this location when you unclick: [[File:Oscar-mac-4-click.png|center]] [[File:Oscar-mac-5-drag.png|center]]
 
−
# <span id="Mac Permission"></span>To launch OSCAR for the first time, you will need to grant it permission, otherwise you will receive an error that it "can't be opened because it is from an unidentified developer." To grant OSCAR permission to run:
 
−
## Hold down the "control" key on your keyboard and click on the new OSCAR icon in the Applications folder. Select "open" from the menu that will appear: [[File:Oscar-mac-6-right-click-open.png|center]]
 
−
## A window will appear advising you that "OSCAR is from an unidentified developer" and asking if you want to run it. Click "Open" to grant it permission: [[File:Oscar-mac-7-open-confirm-with-cursor.png|center]] You will only need to do this the first time you run OSCAR after installing any new version.
 
−
=== Troubleshooting ===
 
−
* Help, I'm getting the following error! [[File:Oscar-mac-8-open-error.png|center|"OSCAR" can't be opened because it is from an unidentified developer.]] This can happen after installing a new version of OSCAR. Open the Applications folder [[#Mac Applications Folder|as shown in step 2 above]] and then [[#Mac Permission|see step 3 above]] to grant OSCAR permission to run.
 
−
 
 
−
==Linux version==
 
−
To install OSCAR on Ubuntu or Debian, download the appropriate file for your platform.  Then:
 
−
 
 
−
<pre>sudo dpkg -i [OSCAR package filename.deb]</pre>
 
−
 
 
−
Substitute the name of the package you downloaded. It is important to use sudo rather than install as root, so that the package will install the .desktop file in your account.
 
−
 
 
−
To remove OSCAR:
 
−
<pre>sudo dpkg -r oscar</pre>
 
−
 
 
−
== Migrating SleepyHead data ==
 
−
 
 
−
OSCAR needs to set up a folder to store your data in. Click '''OK''' to accept the recommended folder or '''No''' to select an alternative folder.<br /><br />
 
−
 
 
 
[[File:Oscar data dialog.png]]
 
[[File:Oscar data dialog.png]]
−
<br /><br />
+
<br /><br /> <br />
−
 
 
−
If you have previously used SleepyHead, OSCAR can ''migrate'' your SleepyHead data (including your settings and preferences) into the new OSCAR data folder. Select '''OK''' for OSCAR to copy your SleepyHead data or else select '''No'''.
 
−
 
 
−
If you select No, Oscar will start and take you to the profile creation page.
 
−
 
 
−
Note that you can only migrate your SleepyHead data at this time. You can copy the raw data (no settings or preferences) later, but it's not so easy and is only recommended for advanced users. See [[Running OSCAR for the first time]] and [[#Copying SleepyHead data (Advanced users)]]
 
−
<br /><br />
 
−
[[File:SleepyHead request.PNG]]
 
−
<br /><br />
 
−
If you select '''OK''' OSCAR will then open a file selector window, where you can locate and select your SleepyHead data folder. OSCAR will then copy all the data across to the new OSCAR data folder, with a bar chart to mark its progress (this can take some little while). Note that the SleepyHead data is copied so the original data stays in place and you can still use it with SleepyHead if you wish.
 
−
<br /><br />
 
−
[[File:SleepyHead Select.png]] <br />
 
−
 
 
−
[[File:Migration.PNG]]
 
−
<br /><br />
 
−
 
 
−
On completion of the data migration, you are ready for review the data migrated from SleepyHead, or set set up a new profile. See [[Running OSCAR for the first time]] <br />
 
−
 
 
−
== Copying SleepyHead data (Advanced users) ==
 
−
 
 
−
If you have not migrated your SleepyHead data as part of the OSCAR installation, you may be able to copy the raw data into your Oscar data file later. Note that this will only work if SleepyHead has backed up the raw data as it's downloaded. If you don't have the data backed up, this process will not work.
 
−
 
 
−
=== Location of backup files ===
 
−
 
 
−
SleepyHead's default configuration will back up your raw data into a folder(s) in your profile directory. The typical path is C:\...\SleepyHead\Profiles\yourname\Machine\Backup (see image below).
 
−
<br /><br /><br />
 
−
[[File:Path to backup.PNG]]
 
−
<br /><br />
 
−
 
 
−
=== Copying raw data ===
 
−
 
 
−
In OSCAR's Welcome page select the ''CPAP Importer'' icon. Alternatively select ''File | Import Data'' from the menu or press {Shift}{F2}. OSCAR will search for an SD card: If the card is found it will bring up a dialog asking if that is where you want to import the data from. If there is no card, it will try to find a data directory on the hard drive(s).
 
−
<br /><br />
 
−
[[File:Folder located.PNG]]
 
−
<br /><br />
 
−
 
−
On the dialog, select '''Specify''', which will take you to a file selector dialog. Navigate to the location of your backup data and select the '''Backup''' folder. OSCAR will then copy the raw data from the backup folder to the OSCAR data folder. If you have more than one machine in your profile, you will need to copy the data from each one individually.
 
  
−
Once the data has been copied across, check the Overview page to ensure there are no unexpected gaps. It is wise to validate the data transfer by viewing a few randomly selected days in both SleepyHead and Oscar to ensure the data is unchanged.
+
== Migrating or importing SleepyHead data ==
 +
If you have previously used SleepyHead, OSCAR gives you two options to bring your existing data across from SleepyHead to OSCAR:
 +
* '''Migrate''' your data - this is only done once during installation and copies all your SleepyHead data plus your profiles and settings to the new OSCAR data folder. Data is updated as required to reflect changes between SleepyHead and OSCAR.  This is the recommended procedure for the majority of users.  
 +
** Details here: [[Migrating SleepyHead data]]
  
 +
* '''Import''' your data from SleepyHead or other OSCAR profile - this can be done anytime after OSCAR has been installed and run. Importing the data only brings the raw data from your CPAP machine and doesn't bring across your profiles or settings. Importing only works if SleepyHead was set up to save a backup copy of your machine data. This process is a little more convoluted and is only recommended for users who are comfortable importing data from files on their computer.
 +
** Details here: [[Importing SleepyHead data]]
  
−
<inputbox>
+
Note that both Migrate and Import leave the existing SleepyHead data untouched so you can still use SleepyHead if you wish to.
−
type=create
 
−
width=100
 
−
break=no
 
−
buttonlabel=Create new article
 
−
default=(OSCAR_supported_machines)
 
−
</inputbox>
 

Latest revision as of 20:59, 11 December 2022

Full-48.png
This article is part of the official OSCAR software project. (OSCAR Help)

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.

OSCAR installation process

Installing OSCAR requires only a few steps:

  1. Download the OSCAR installer for your computer from the official download page.
  2. Install OSCAR. This process differs for each type of computer, see below for details.
  3. Run OSCAR and select where you want OSCAR to save your data when it asks you. You can simply accept its recommendation.
    1. Note: Do not select the SD card itself as the destination. Select a location on your PC hard drive (or just accept the recommendation).
  4. If you've been using SleepyHead, see below for how to migrate your previous SleepyHead data. Otherwise, see "Running OSCAR for the first time" to set up a new profile and import the data from your machine.

Download and install

OSCAR is available at the official download page: https://www.sleepfiles.com/OSCAR/

There are OSCAR versions available for Windows, Apple Mac and Linux. Detailed instructions may be found at the following links:

You may also read the page in a number of different languages - the list of languages is along the top of the page.

OSCAR is open source software, and there are links to the source code near the bottom of the page. Note that this is for software developers - the great majority of users don't need to worry about the source code.

OSCAR data folder

OSCAR needs to set up a folder to store your data in. Click OK to accept the recommended folder or No to select an alternative folder. Note: Do not select the SD card itself as the destination. Select a location on your PC hard drive (or just accept the recommendation).

Oscar data dialog.png


Migrating or importing SleepyHead data

If you have previously used SleepyHead, OSCAR gives you two options to bring your existing data across from SleepyHead to OSCAR:

  • Migrate your data - this is only done once during installation and copies all your SleepyHead data plus your profiles and settings to the new OSCAR data folder. Data is updated as required to reflect changes between SleepyHead and OSCAR. This is the recommended procedure for the majority of users.
  • Import your data from SleepyHead or other OSCAR profile - this can be done anytime after OSCAR has been installed and run. Importing the data only brings the raw data from your CPAP machine and doesn't bring across your profiles or settings. Importing only works if SleepyHead was set up to save a backup copy of your machine data. This process is a little more convoluted and is only recommended for users who are comfortable importing data from files on their computer.

Note that both Migrate and Import leave the existing SleepyHead data untouched so you can still use SleepyHead if you wish to.




Donate to Apnea Board  

Retrieved from "http://www.apneaboard.com/wiki/index.php?title=OSCAR_Installation&oldid=6644"