caffeinejs

Caffeine

Lightweight library for mobile web browsers to prevent phones from sleeping.

Installation

Copy the file ./lib/caffeine.js or the minified version to your web server and then link it in your HTML:

<script type="text/javascript" src="caffeine.min.js"></script>

Usage

At the bottom of your document after including caffeine.js, add the following:

<script>
  caffeine.start(); // keep phone awake
 
  caffeine.stop();  // allow phone to sleep
</script>

Or with browserify, your pre-build js file would look like:

var caffeine = require('caffeine');
 
caffeine.start(); // keep phone awake
 
caffeine.stop();  // allow phone to sleep

Supported Platforms

• iOS 7.1.2, Safari

License (MIT)

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

Copyright (c) 2015, Andy Jiang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.