Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 1.92 KB

README.md

File metadata and controls

74 lines (50 loc) · 1.92 KB
Raw

A Python library for the LIFX cloud HTTP API

Installing PIFX

Install PIFX using pip:

  • pip install pifx

Install PIFX from source:

  • git clone https://github.com/cydrobolt/pifx.git
  • cd pifx
  • python setup.py install

Using PIFX

Create an API key

Importing PIFX in your Python file:

  • from pifx import PIFX

Creating a PIFX instance:

  • p = PIFX('API_KEY_GOES_HERE')

Performing PIFX actions:

import pifx

p = pifx.PIFX(api_key='API_KEY_GOES_HERE')

p.toggle_power() # toggle all lights
p.toggle_power('label:Bedroom') # toggle light with label "Master Bedroom"

p.set_state(color='blue', brightness='0.85') # set brightness to 85% and color to blue
p.pulse_lights(color='red', duration=2.5) # pulse lights for 2.5 seconds

Read the docs for full usage instructions.

Hacking on PIFX

Running tests:

  • pip install nose
  • nosetests

Contributing:

  • We appreciate contributions from all users.
  • Fork the project, add your changes, and make a pull request.
  • Thank you!

Other information

PIFX is an open source library not affiliated or endorsed by LIFX ®

 Copyright © 2015 Chaoyi Zha <[email protected]>

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.