Giter VIP home page Giter VIP logo

relay-lib's Introduction

About

Basic relay control library. Based off of http://awtfy.com/2011/07/14/a-too-simple-arduino-library-for-handling-the-seeeduino-relay-shield-and-generic-relays/

##Constructors

// Empty constructor.  Will cause problems if not replaced with another
// constructor at some point, or initialized with init() function
RelayLib relay = RelayLib();

// Constructor for use with standard digitalWrite function. initState is
// optional and defaults to LOW
// NOTE: Will run pinMode for you.
RelayLib relay = RelayLib(relayPin, initState); 

// Constructor for use with any function like digitalWrite. initState
// optional as before.
// NOTE: Will not setup pin mode. SET IT UP FIRST!
// digitalWrite like function must be of form:
// void function(uint16_t, uint8_t)
//
// E.G. using the MCP23008 GPIO expander:
void mcpDigitalWrite(uint16_t p, uint8_t d) {
    mcp.digitalWrite(p, d);
}

RelayLib relay = RelayLib(mcpDigitalWrite,relayPin,initState);

// Init functions are similar to constructor forms:
relay.init(relayPin, initState);
relay.init(mcpDigitalWrite,relayPin,initState);

##Member Functions

// Turns relay on
void on();    
// Turns relay off
 void off();  
// Toggles state of relay between on and off
void toggle();  
// pulse relay on, then off after delay (in ms).
// If already on, will turn it off after the given delay time
void pulse(int delayTime=300); 

// returns state of relay (LOW/0/off or HIGH/1/on)
int state(); 

// Returns TRUE if the relay is on , false otherwise.
// Both functions are identical, and retained for backwards compatibility
bool isRelayOn();
bool isOn();

// Returns TRUE if the relay is off, false otherwise
bool isRelayOff();  
bool isOff();

relay-lib's People

Contributors

joegoggins avatar meawoppl avatar mumblepins avatar shime avatar technobly avatar wgbartley avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.