Welcome to sainsmart’s documentation!

Contents:

sainsmart

PyPi Travis Build Documentation Status Updates Coverage Windows Build

sainsmart contains code for working with sainsmart products.

Install

pip install sainsmart

Usage

To use EthernetRelay in a project:

from sainsmart import devices

relay = devices.EthernetRelay()

# Access the state of the relays
# relay.state() is a list of bools
relay_state = relay.state()

# Turn on the relay at index 0.
relay.turn_on(0)

# Turn off the relay at index 0.
relay.turn_off(0)

# Toggle the state of relay 0.
relay.toggle(0)

# Turn on all relays.
relay.all_on()

# Turn off all relays.
relay.all_off()

The SainSmart Ethernet Relay defaults ip address: 192.168.1.4/30000. This can be changed through their web interface.

To use EthernetRelay with a different IP address:

from sainsmart import devices

relay = devices.EthernetRelay('http://192.168.44.100/30000')

Example

Here is an example with a real device:

>>> from sainsmart import devices
>>> relay = devices.EthernetRelay()
>>> relay.state()
[False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
>>> relay.turn_on(0)
>>> relay.state()
[True, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
>>> relay.toggle(0)
>>> relay.state()
[False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
>>> relay.all_on()
>>> relay.state()
[True, True, True, True, True, True, True, True, True, True, True, True, True, True, True, True]
>>> relay.turn_off(0)
>>> relay.state()
[False, True, True, True, True, True, True, True, True, True, True, True, True, True, True, True]
>>> relay.all_off()
>>> relay.state()
[False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install sainsmart, run this command in your terminal:

$ pip install sainsmart

This is the preferred method to install sainsmart, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for sainsmart can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/vicyap/sainsmart

Or download the tarball:

$ curl  -OL https://github.com/vicyap/sainsmart/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use EthernetRelay in a project:

from sainsmart import devices

relay = devices.EthernetRelay()

# Access the state of the relays
# relay.state() is a list of bools
relay_state = relay.state()

# Turn on the relay at index 0.
relay.turn_on(0)

# Turn off the relay at index 0.
relay.turn_off(0)

# Toggle the state of relay 0.
relay.toggle(0)

# Turn on all relays.
relay.all_on()

# Turn off all relays.
relay.all_off()

The SainSmart Ethernet Relay defaults ip address: 192.168.1.4/30000. This can be changed through their web interface.

To use EthernetRelay with a different IP address:

from sainsmart import devices

relay = devices.EthernetRelay('http://192.168.44.100/30000')

Example

Here is an example with a real device:

>>> from sainsmart import devices
>>> relay = devices.EthernetRelay()
>>> relay.state()
[False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
>>> relay.turn_on(0)
>>> relay.state()
[True, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
>>> relay.toggle(0)
>>> relay.state()
[False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]
>>> relay.all_on()
>>> relay.state()
[True, True, True, True, True, True, True, True, True, True, True, True, True, True, True, True]
>>> relay.turn_off(0)
>>> relay.state()
[False, True, True, True, True, True, True, True, True, True, True, True, True, True, True, True]
>>> relay.all_off()
>>> relay.state()
[False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False]

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/vicyap/sainsmart/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

sainsmart could always use more documentation, whether as part of the official sainsmart docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/vicyap/sainsmart/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up sainsmart for local development.

  1. Fork the sainsmart repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/sainsmart.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv sainsmart
$ cd sainsmart/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ make lint
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/vicyap/sainsmart/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_sainsmart

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.3.1 (2017-06-20)

  • make the regex for getting the state of the relays more specific

0.3.0 (2017-06-14)

  • add python 3.4 support

0.2.1 (2017-06-14)

  • add install section to README
  • fix coverage badge in README

0.2.0 (2017-06-14)

  • python2.7 support
  • renamed sainsmart.py to devices.py

0.1.1 (2017-06-12)

  • Update usage and docs

0.1.0 (2017-06-12)

  • First release on PyPI.

Indices and tables