Difference between revisions of "ECE434 Project - Comrade Candles: Linked Lighting"

From eLinux.org
Jump to: navigation, search
(Installation Instructions)
(Installation Instructions)
Line 48: Line 48:
  
 
== Installation Instructions ==
 
== Installation Instructions ==
 
Give step by step instructions on how to install your project. 
 
 
 
* Github Repository:  [https://github.com/rutantj/comrade-candles-ECE434 https://github.com/rutantj/comrade-candles-ECE434]. The final code for this project is in musicAndLED folder but you can use the other folders to implement only certain parts of the project. It should be noted that while the ir-and-uart files have the ability to take input from an IR sensor, it can not reliably distinguish between different inputs and should not be used in its current state.  
 
* Github Repository:  [https://github.com/rutantj/comrade-candles-ECE434 https://github.com/rutantj/comrade-candles-ECE434]. The final code for this project is in musicAndLED folder but you can use the other folders to implement only certain parts of the project. It should be noted that while the ir-and-uart files have the ability to take input from an IR sensor, it can not reliably distinguish between different inputs and should not be used in its current state.  
  
Line 56: Line 53:
  
 
* After navigating to the musicAndLED folder, set up the PRU (our code uses PRU0 but you could configure it to work with PRU 1) source the setup.sh file. Then log in as root and run make (sudo will not work with the make file)
 
* After navigating to the musicAndLED folder, set up the PRU (our code uses PRU0 but you could configure it to work with PRU 1) source the setup.sh file. Then log in as root and run make (sudo will not work with the make file)
bone1$ '''source setup.sh'''
+
bone1$ '''source setup.sh'''
bone1$ '''make'''
+
bone1$ '''make'''
  
 
TODO: talk about make file problem
 
TODO: talk about make file problem
  
 
Finally, we will connect to our Pagekite page
 
Finally, we will connect to our Pagekite page
bone1$ '''python pagekite ''username1''.pagekite.me'''
+
bone1$ '''python pagekite ''username1''.pagekite.me'''
  
 
Your bone is now ready to run the code!  Open a new terminal and run serverLED.py and you'll bone will be ready to communicate.
 
Your bone is now ready to run the code!  Open a new terminal and run serverLED.py and you'll bone will be ready to communicate.
bone1$ '''serverLED.py'''  
+
bone1$ '''serverLED.py'''  
  
 
* The last step is to repeat this process with the 2nd bone and your bones you're ready to start sending LED messages to each other.
 
* The last step is to repeat this process with the 2nd bone and your bones you're ready to start sending LED messages to each other.
  
bone2$ '''source setup.sh'''
+
bone2$ '''source setup.sh'''
bone2$ '''make'''
+
bone2$ '''make'''
bone2$ '''python pagekite ''username2''.pagekite.me'''  TODO: double check this
+
bone2$ '''python pagekite ''username2''.pagekite.me'''  TODO: double check this
bone2$ '''serverLED.py
+
bone2$ '''serverLED.py
  
 
== User Instructions ==
 
== User Instructions ==

Revision as of 18:30, 16 November 2021

thumb‎ Embedded Linux Class by Mark A. Yoder


Team members: Tom Kirchhoffer, T.J. Rutan, and Samuel VanDenburgh

Grading Template

I'm using the following template to grade. Each slot is 10 points. 0 = Missing, 5=OK, 10=Wow!

09 Executive Summary
09 Packaging
09 Installation Instructions 
09 User Instructions
09 Highlights
09 Theory of Operation
09 Work Breakdown
09 Future Work/Conclusions
09 Hackster.io
09 Demo/Poster
00 Not Late

Score:  90/100

Executive Summary

(I left in the instructions so we can see them and edit more accordingly-Sam)

Picture that summarizes the project.

Give two sentence intro to the project. Comrade Candles are a set of customizable led strips that synchronize colors and flashing speeds over the internet, It also has a sound implementation that allows preloaded songs to be played as well. This allows users to have a creative way to communicate and express themselves with a friend so long as both have an internet connection.

Give two sentences telling what works. Using flask and pagekite, we are able to use a Beagle Bone to run python files on another Beagle Bone. Using this concept, we have implemented a way for the lights to change on one Beagle and Match the other, as well as play matching audio files (so long as both Bones have the audio file downloaded).

Give two sentences telling what isn't working. The IR remote input was not ale to be implemented for the project. With the remote and transceiver we chose to use and a lack of libraries to use for decoding signals. We could not find any consistent patterns that distinguished each signal from the remote, making it impossible for us to implement.

End with a two sentence conclusion. Using the method that implemented the comrade candle project, we are able to create a way to synchronize operations on two bones so long as they have the same scripts on them. While this was used for our comrade candle project, there is a vast range of projects such concepts to apply to. The files should also be able to be modifiable to incorporate more than 2 bones as well. The only negative side is pagekite has only a month long trial so a free solution that could last permanently would be preferred and ideal for a user.

The sentence count is approximate and only to give an idea of the expected length.

Packaging

If you have hardware, consider Small Build, Big Execuition for ideas on the final packaging.

Installation Instructions

  • Github Repository: https://github.com/rutantj/comrade-candles-ECE434. The final code for this project is in musicAndLED folder but you can use the other folders to implement only certain parts of the project. It should be noted that while the ir-and-uart files have the ability to take input from an IR sensor, it can not reliably distinguish between different inputs and should not be used in its current state.
  • Before we can run the code we must first setup Pagekite accounts to allow our bones to be access through the internet. Head over to https://pagekite.net/, make an account and curl Pagekite to the bone using the following: TODO show how to curl Pagekite
  • After navigating to the musicAndLED folder, set up the PRU (our code uses PRU0 but you could configure it to work with PRU 1) source the setup.sh file. Then log in as root and run make (sudo will not work with the make file)
bone1$ source setup.sh
bone1$ make

TODO: talk about make file problem

Finally, we will connect to our Pagekite page

bone1$ python pagekite username1.pagekite.me

Your bone is now ready to run the code! Open a new terminal and run serverLED.py and you'll bone will be ready to communicate.

bone1$ serverLED.py 
  • The last step is to repeat this process with the 2nd bone and your bones you're ready to start sending LED messages to each other.
bone2$ source setup.sh
bone2$ make
bone2$ python pagekite username2.pagekite.me  TODO: double check this
bone2$ serverLED.py

User Instructions

Once everything is installed, how do you use the program? Give details here, so if you have a long user manual, link to it here.

Consider making it autostart for full credit.

Highlights

Here is where you brag about what your project can do.

Include a YouTube demo the audio description.

Theory of Operation

Give a high level overview of the structure of your software. Are you using GStreamer? Show a diagram of the pipeline. Are you running multiple tasks? Show what they do and how they interact.

Work Breakdown

List the major tasks in your project and who did what.

Also list here what doesn't work yet and when you think it will be finished and who is finishing it.

Future Work

Suggest addition things that could be done with this project.

Conclusions

Give some concluding thoughts about the project. Suggest some future additions that could make it even more interesting.




thumb‎ Embedded Linux Class by Mark A. Yoder