Sleep Monitor User Guide

This guide contains information about how to use DssW Sleep Monitor. This guide has been written for users of Sleep Monitor. Administrators and developers should contact DssW support with any unanswered questions.

This guide assumes you have working knowledge of the Mac operating system and its conventions. For help with the operating system, please see your Mac OS documentation.

Hardware and Software Requirements

To use DssW Sleep Monitor, you need the following hardware and software:

• A Mac OS X capable computer;
• Mac OS X 10.6, aka Snow Leopard, or later.

Welcome to Sleep Monitor. Let’s walk through how to install Sleep Monitor and start auditing your Mac’s energy and power state.

Installing Sleep Monitor

Sleep Monitor is a Mac application. The application contains everything you need to get started.

Back Up Before Installing New Software

Remember to back up your Mac before installing Sleep Monitor. You must always back up before installing any new software on your Mac. If something should go wrong, or if you experience problems, a recent back up is essential to returning your Mac to a known state.

Downloading Sleep Monitor

To install Sleep Monitor, you need a copy of the latest Sleep Monitor distribution from DssW. The latest distribution is free to download from the DssW web site.

Visit the following page and the latest Sleep Monitor distribution will automatically begin downloading:

https://www.dssw.co.uk/sleepmonitor/download

The distribution file is a disk image and, once downloaded, will appear in your Downloads folder.

Once you have a copy of the Sleep Monitor distribution, you do not need to be connected to the Internet to complete the installation.

Installing Over Older Versions

It is safe to install Sleep Monitor over the top of an existing installation.

We always recommend keeping your installation of Sleep Monitor up-to-date, because we regularly release free updates and improvements to Sleep Monitor. Sleep Monitor includes an automatic software update mechanism that will warn you about new versions. Alternatively, you can update your version of Sleep Monitor by downloading and installing the latest version over the top of an older version.

Mounting the Sleep Monitor Disk Image

Sleep Monitor is distributed as a disk image. A disk image is a virtual disk that contains a collection of folders and files. To use a disk image, open the file from the Finder. You can double-click the disk image file to open it.

A disk image is ‘mounted’ once it has been opened. The mounted disk image will appear alongside your other devices in Mac OS X’s Finder, much like an external hard disk drive or DVD.

The mounted Sleep Monitor disk image contains the Sleep Monitor application and any release notes. If available, take the time to read the release notes. The notes contain comments about last minute changes or additions to Sleep Monitor. They may also contain specific instructions about the latest distribution of Sleep Monitor.

Copying Sleep Monitor

Copy the Sleep Monitor application from the disk image to your Applications folder. This can be done using the Finder by dragging and dropping the application icon onto the Application folder icon. Alternatively, yo ucan use the Copy and Paste menu items.

You can copy Sleep Monitor to other locations on your Mac but we recommend keeping your applications together in the Applications folder.

Once a copy of Sleep Monitor is in your Mac’s Applications folder, you can eject and safely delete the disk image.

Starting Sleep Monitor

The first time you launch Sleep Monitor, a welcome message will be displayed. After reading the message you will be given the option to install a background helper tool.

The background helper tool is required to collect information about what your Mac is doing. Without the helper tool, Sleep Monitor will have no information to show you.

The helper tool can be installed in a number of ways. This provides flexibility in what Sleep Monitor can report on, and which users can see the information.

Let’s look at each option for installing the helper tool:

Install for Everyone

The helper tool can be set to run whenever the Mac is powered on. The helper tool will continue even if no-one is logged in and is not affected by users logging in and out. The helper tool will continue gathering information for Sleep Monitor until you ask it to stop.

Install for You

The helper tool can be set to run only when you are logged in. This includes stopping when you log out, and resuming when you log back in. The helper tool will continue gathering information for Sleep Monitor until you ask it to stop.

Skip Install: Run Until Log Out

You can skip the installation process. In this situation the helper tool will be launched but not installed. The helper tool will gather information until you ask it to stopped, or until you next log out; whichever happens first.

Starting Sleep Monitor

1. Launch the Sleep Monitor application.
2. Click on the Start button at the top-left of the main window.
3. Select how to run the helper tool.
4. Click the Install or Skip button.

Stopping Sleep Monitor

You can start and stop Sleep Monitor gathering information at any time.

Stop Sleep Monitor

1. Launch the Sleep Monitor application.
2. Click on the Stop button at the top-left of the main window.

AppleScript

Sleep Monitor includes support for Apple’s automation language AppleScript. With AppleScript you can integrate Sleep Monitor in your workflows and automate potentially repetitive tasks.

If you are new to AppleScript, the following two links will give you a good overview of the language and provide resources to get started. Take some time to gain a broader understanding of what it possible, then come back and enjoy the extensive scripting support we provide.

• Overview of AppleScript
• AppleScript Resources

Scripting Sleep Monitor

Sleep Monitor supports AppleScript.

Event Properties

Get the properties of individual events logged by Sleep Monitor.

tell application "Sleep Monitor"
    
    -- get everything about the last recorded event
    set theProperties to properties of the last event
    
    -- which monitor recorded the middle event
    set theMonitor to monitor of the middle event
    
    -- count the number of restart events
    set howManyRestarts to number of (events where summary contains "restart")
    
end tell

Zoom Out

Adjust Sleep Monitor’s visible range to show the last six days.

set days to (24 * 60 * 60)
set newStart to (current date) - (5.9 * days)

-- zoom in to today
tell application "Sleep Monitor"
    set startDay of visibleSlice to current date
    set endDay of visibleSlice to current date
end tell

repeat 30 times
    
    tell application "Sleep Monitor"
        
        set startDay of visibleSlice to (startDay of visibleSlice) - (1 * days)
        
    end tell
    
end repeat

Export the Graph

Save the current graph to the Desktop folder as a PNG (Portable Network Graphics) file.

set myFilename to "sleepmonitor-chart.png"

tell application "Sleep Monitor"
    
    set myPath to ((path to desktop) & myFilename) as string
    export graph visibleSlice to myPath border no title no
    
end tell

Software Licence Agreement

PLEASE READ THIS LICENCE CAREFULLY BEFORE USING THE SOFTWARE. BY USING THE SOFTWARE YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS LICENCE. IF YOU DO NOT AGREE TO THE TERMS OF THIS LICENCE, PROMPTLY RETURN THE UNUSED SOFTWARE TO THE PLACE WHERE YOU OBTAINED IT AND YOUR MONEY WILL BE REFUNDED.

Notice To User: This is a contract between you and Dragon Systems Software Limited (“DssW”), a company incorporated under the laws of England, United Kingdom, by installing and using this Product (the Software) you accept all the terms and conditions of this Agreement. If you do not agree with the terms and conditions of this Agreement, cease to use the Product and remove it from your Computer Systems.

This is a licence agreement and not an agreement for sale. DssW continues to own the copy of the Product and any other copy that you are authorised to make pursuant to this Agreement.

This licence accompanies software (“Software”) and related explanatory materials (“Documentation”). The term “Software” shall also include any upgrades, modified versions, updates, additions and copies of the Software licensed to you by DssW. DssW grants you a non-exclusive licence to use the Software and Documentation, provided that you agree to the following:

1. Use of the Software. You may -

   1. Install the Software in a single computer up to the number of Licensed Seats that you own.

   2. Provided the Software is configured for network use, install and use the Software on a single file server for use on a single local area network for either (but not both) of the following purposes:

      1. permanent installation onto a computer of up to the Seats stated by your Licences; or

      2. use of the Software over such network, provided the number of different computers on which the Software is used does not exceed the number of Seats stated by your Licences you own. For example, if there are 50 computers connected to the server, with no more than 10 computers ever using the Software at the same time, but the Software will be used on 20 different computers at various times, the number of Licensed Seats for which you need is 20.

   3. Make one backup copy of the Software, provided your backup copy is not installed or used on any computer.

   4. If you do not own a Licence for the Software, you may use a Demonstration of the Software for a maximum period of thirty (30) days, after which time you no longer have a Licence to use the Software, and all copies thereof, including copies installed on computers, must be destroyed.

   5. If you own Academic Licences of any kind, you may only use the Software within academic institutions and for non commercial purposes only.

   6. If you own a Site, Organisation or Location based Licence of any kind, you may install and use the Software in any computer within the Licensed Site or Organisation. DssW must be, on request, promptly provided with geographic limits of the physical location covered by any Site or Organisation Licence.

   7. Not for Resale Software. If the Software is labeled “Not For Resale” or “NFR”, then, notwithstanding other sections of this Agreement, your use of the Software is limited to use for demonstration, test, or evaluation purposes and you may not resell, or otherwise transfer for value, the Product.

   THE SOFTWARE IS NOT INTENDED FOR USE IN FACILITIES OR ENVIRONMENTS IN WHICH CASE THE FAILURE OF THE SOFTWARE COULD LEAD TO DEATH, PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE.

2. Copyright.

   The Software is the intellectual property of DssW and its suppliers and is protected by United Kingdom copyright law, international treaty provisions, and applicable laws of the country in which it is being used. You agree not to modify, adapt, translate, reverse engineer, decompile, disassemble or otherwise attempt to discover the source code of the Software.

3. Ownership.

   The Software and documentation are licensed, not sold, to you for use only under terms of this Licence. DssW reserves all rights not expressly granted to you in the Licence. DssW and/or DssW’s licensors retain title to the Software and related documentation and all intellectual property rights therein. This agreement does not grant you any intellectual property rights.

4. Transfer.

   You may not rent, lease, sub license, transfer or lend DssW Licences. You may not distribute the Software or Documentation without explicit permission from DssW.

5. Upgrades.

   If you acquire an upgrade or update for the Software, you may use the previous version for ninety (90) days after you receive the new version in order to assist you in the transition to the new version, after which time you no longer have a Licence to use the previous version, and all copies thereof, including copies installed on computers, must be destroyed.

6. Limited Warranty.

   DssW warrants to you that the Software will perform substantially in accordance with the Documentation for the thirty (30) day period following your receipt of the Software. To make a warranty claim, you must contact DssW within the thirty (30) day period for further instructions. If the Software does not perform substantially in accordance with the Documentation, the entire and exclusive liability of DssW and its suppliers, and exclusive remedy shall be limited to either, at DssW’s option, the replacement of the Software or the refund of the Licence fee you paid for the Software. Where a fee is refunded, DssW may decide the method of returning the fee.

   DssW and its suppliers do not and cannot warrant the performance or results you may obtain by using the Software or Documentation. The foregoing states that the sole and exclusive remedies for DssW’s or its suppliers’ breach of the warranty. Except for the foregoing limited warranty, and for any warranty which cannot be excluded or limited by compulsory law in the United Kingdom, DssW and its suppliers make no warranties or conditions, express or implied, as to the non infringement of third party rights, merchantability, satisfactory quality or fitness for any particular purpose. In no event will DssW or its suppliers be liable to you for any damages whatsoever (including, without limitation consequential, incidental, or special damages, including any lost profits or lost savings) arising out of the use or inability to use the Software even if a DssW representative has been advised of the possibility of such damages, or for any claim by third party. Where liability cannot be legally excluded, but it may be limited, DssW’s liability and that of its suppliers shall be limited to the amount paid for the Licences.

   Nothing contained in this Agreement shall prejudice the statutory rights of any party dealing as a consumer.

7. Governing Law and General Provisions.

   This Agreement shall be governed by and construed in accordance with the laws of England, United Kingdom whose courts shall have jurisdiction over all disputes relating to the Agreement.

   This is the entire agreement between DssW and you relating to the Product and it supersedes any prior representations, discussions, undertakings, end user licence agreements, communications or advertising relating to the Product.

   If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms. This agreement will automatically terminate upon failure by you to comply with its terms. This shall not prejudice the statutory rights of any party dealing as a consumer. This Agreement may only be modified in writing signed by an authorised officer of DssW.

   Unpublished-rights reserved under the copyright laws of the United Kingdom. Dragon Systems Software Limited, 3rd Floor Suite, 41-43 Broad Street, Hereford, Herefordshire, HR4 9AR, United Kingdom.

If you have any questions concerning this agreement, please do not hesitate to contact DssW by e-mail support@dssw.co.uk or write to:

Dragon Systems Software Limited
3rd Floor Suite 41-43 Broad Street Hereford, Herefordshire
HR4 9AR
United Kingdom

Legal Notice

No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical, electronic, photocopying, recording, or otherwise, without prior written permission of Dragon Systems Software Limited, with the following exceptions: Any licensed user of DssW Sleep Monitor is hereby authorised to store this material on their licensed computer for personal use only and to print copies of documentation for personal use provided that the documentation contains DssW’s copyright notice.

No licences, express or implied, are granted with respect to any of the technology described in this book. DssW retains all intellectual property rights associated with the technology in this publication.

This publication is intended to assist users of DssW Sleep Monitor only.

Apple™, AppleScript™, Automator™, iPhone™, iPod™, iOS™, Mac™, Mac OS X™, Macintosh™ are trademarks of Apple, Inc., registered in the United States and other countries. All other trademarks are the property of their respective owners.

This publication is provided for information use only, is subject to change without notice, and should not be construed as a commitment by Dragon Systems Software Limited (DssW).

Dragon Systems Software Limited (DssW) assumes no responsibility or liability for any errors or inaccuracies that may appear in this publication.