Gordons Projects

--> Projects Top-Level GIT

Minor update to make sure it's all OK with wiringPi v2
[halloweenPi] / README.TXT
1
2  * Halloween Pi
3  **************
4  *      A little seasonal project for the MagPi magazine - however
5  *      it demonstrates the use of software PWM to control a pair
6  *      of RGB LEDs and reading from a PIR sensor
7  *
8  *      Copyright (c) Gordon Henderson, 2012-2013.
9  **********************************************************************
10
11 The software here is designed to control the two RGB LEDs triggererd
12 from a PIR - Passive Infra Red sensor.
13
14 There are 3 files of code and a Makefile. The Makefile is a set of rules
15 which gives instructions about building the code.
16
17 To compile and run, type:
18
19   make
20   sudo ./halloween
21
22 If you do not have wiringPi installed, then you will get failures,
23 so install wiringPi:
24
25   pushd /tmp
26   git clone git://git.drogon.net/wiringPi
27   cd wiringPi
28   ./build
29   popd
30
31 If you get an error when running the git command, then:
32
33   sudo apt-get install git-core
34
35
36
37 The three program files -
38
39 halloween.c:    This is the main program - it initialises the
40                 sensor and LEDs and the performs actions when
41                 the sensor is triggered.
42
43 ledControl.c    This sets up the RGB LEDs and provides a function to
44                 program any RGB value to either LED.
45
46 ledPatterns.c:  This is code to create many different patterns on the
47                 LEDs.
48
49 Of these files, the last one, ledPatterns.c is probably he one you want
50 to play with. You can change one of the existing functions, or add new
51 functions into it.
52
53 To add in a new pattern:
54
55 Write the function - try to use the same style as the existing ones and
56 have it run for a set period of time.
57
58 Add an entry into ledPatterns.h
59
60 Call the code from the main halloween.c program.