pirlib2.h

Go to the documentation of this file.

/*

PIR-1/PIR-4 Driver v2

Copyright (c) 2014, Promixis, LLC
All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the following
disclaimer.

2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef PIRLIB2_H
#define PIRLIB2_H

#include "pirlib2_global.h"

#ifdef __cplusplus
extern "C" {
#endif

#define PIR_ARRIVED_STATUS  1
#define PIR_REMOVED_STATUS  2


typedef void (*fStatusCB) ( const char * serial, unsigned char status, void * userData);

typedef void (*fIrReceivedCB) ( const char * serial, const unsigned int * pulses, unsigned int pulseCount, void * userData);

typedef void (*fIrSentCB) ( const char * serial, unsigned char status, void * userData );


typedef void (*fIrRawLearnCB) ( const char * serial, unsigned int modulation, const unsigned int * pulses, unsigned int pulseCount, void * userData );


#define PIR_BUTTON_IDLE     0
#define PIR_BUTTON_DOWN     1
#define PIR_BUTTON_REPEAT   2
#define PIR_BUTTON_UP       3

typedef void (*fButtonCB) ( const char * serial, int button1, int button2, int button3, int button4, void * userData );

typedef struct {
    int size;
    fIrSentCB sendCallback;
    fStatusCB statusCallback;
    fIrReceivedCB receiveCallback;
    fButtonCB buttonCallback;
    fIrRawLearnCB rawLearnCallback;
    void * unused;
    void * userData;
} PIR_Settings;

PIRLIB2SHARED_EXPORT int pir_open( PIR_Settings * settings );

PIRLIB2SHARED_EXPORT int pir_close();


PIRLIB2SHARED_EXPORT int pir_sendCCF ( const char * serial, const char * ccf, int bitmask, unsigned char repeats ) ;

PIRLIB2SHARED_EXPORT unsigned int pir_list1 ( char * buffer, unsigned int size );


PIRLIB2SHARED_EXPORT unsigned int pir_list4 ( char * buffer, unsigned int size );

PIRLIB2SHARED_EXPORT int pir_version ( const char * serial );


PIRLIB2SHARED_EXPORT int pir_blink( const char * serial, unsigned char count );

#define PIR_PIR_1   1
#define PIR_PIR_4   4



PIRLIB2SHARED_EXPORT int pir_type( const char * serial );


PIRLIB2SHARED_EXPORT int pir_detect( );


PIRLIB2SHARED_EXPORT int pir_learn( const char * serial );

PIRLIB2SHARED_EXPORT int pir_cancelLearn( const char * serial );

#ifdef __cplusplus
}
#endif


#endif // PIRLIB2_H