This repository has been archived by the owner on Dec 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Readme.md päivitystä Dokumentaation päivitystä
- Loading branch information
Showing
1 changed file
with
176 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,204 @@ | ||
| # Speeden Spelit | ||
| <!-- Improved compatibility of Takaisin alkuun link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --> | ||
| <a id="readme-top"></a> | ||
| <!-- | ||
| *** Thanks for checking out the Best-README-Template. If you have a suggestion | ||
| *** that would make this better, please fork the repo and create a pull request | ||
| *** or simply open an issue with the tag "enhancement". | ||
| *** Don't forget to give the project a star! | ||
| *** Thanks again! Now go create something AMAZING! :D | ||
| --> | ||
|
|
||
| Tämä repository on tarkoitettu Oulun ammattikorkeakoulun TVT24KMO-luokan, Ryhmän 24 tietotekniikan sovellusprojektia varten, jossa toteutamme Speeden Spelit (nopeuspeli) -pelin käyttämällä Arduino Uno -mikrokontrolleria ja muita elektroniikkakomponentteja. | ||
|
|
||
| ## Ryhmän jäsenet | ||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/AleksandrCGM"><img src="https://avatars.githubusercontent.com/u/160769064" width="100px;" alt=""/><br /><sub><b>Aleksandr Starchenkov</b></sub></a><br /><a title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/Dmitrytroshkov"><img src="https://avatars.githubusercontent.com/u/181249129" width="100px;" alt=""/><br /><sub><b>Dmitry Troshkov</b></sub></a><br /><a title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/AlexeySheykin"><img src="https://avatars.githubusercontent.com/u/181261717" width="100px;" alt=""/><br /><sub><b>Alexey Sheykin</b></sub></a><br /><a title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/vem882"><img src="https://avatars.githubusercontent.com/u/494950" width="100px;" alt=""/><br /><sub><b>Martin Negin</b></sub></a><br /><a title="Code">💻</a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Projektissa käytettävät komponentit | ||
| <!-- PROJECT SHIELDS --> | ||
| <!-- | ||
| *** I'm using markdown "reference style" links for readability. | ||
| *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
| *** See the bottom of this document for the declaration of the reference variables | ||
| *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
| *** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
| --> | ||
| [![Contributors][contributors-shield]][contributors-url] | ||
| [![Forks][forks-shield]][forks-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
| [![Issues][issues-shield]][issues-url] | ||
| [![GUI License][license-shield]][license-url] | ||
|
|
||
|
|
||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="https://github.com/othneildrew/Best-README-Template"> | ||
| <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| <h3 align="center">Speden Spelit: Arduino UNO</h3> | ||
|
|
||
| <p align="center"> | ||
| **Speden Spelit** - Nopeus muistipeli, jossa pelaaja painaa painikkeita, sitä mukaan kun painiketta vastaava ledi syttyy. Peli nopeutuu sitä, mukaan kun pelaaja painaa oikeita painikkeita oikean aikaan. | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Sisällysluettelo</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#tietoa-projektista">Tietoa projektista</a> | ||
| <ul> | ||
| <li><a href="#Rakennettu-käyttäen">Rakennettu käyttäen</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#näin-pääset-alkuun">Näin pääset alkuun</a> | ||
| <a href="#vuokaavio">Vuokaavio</a> | ||
| <a href="#kytkentä">Kytkentäkaavio</a> | ||
| </li> | ||
| <li><a href="#käyttö">Käyttö</a></li> | ||
| <li><a href="#jatkokehitys">Jatkokehitys</a></li> | ||
| <li><a href="#osallistujat">Osallistujat</a></li> | ||
| <li><a href="#lisenssi">Lisenssi</a></li> | ||
| <li><a href="#kiitokset">Kiitokset</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
|
|
||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| ## Tietoa projektista | ||
|
|
||
| [![SpedenSpell][product-screenshot]](https://example.com) | ||
|
|
||
| Tämä projekti on osa Oulun ammattikorkeakoulun "Tietotekniikan sovellusprojekti" -kurssia. **Speden Spelit** on fyysinen muistipeli ja nopeuspeli, jossa pelaajan tulee painaa oikeita nappeja syttyvien LED-valojen mukaisessa järjestyksessä. Peli vaikeutuu jokaisen viiden pisteen jälkeen nopeuttamalla valojen syttymisrytmiä. | ||
|
|
||
| Peli alkaa, kun käyttäjä painaa mitä tahansa painiketta tai jos laite kytketään virtoihin syttyy kaikki ledit, sekä 7-segmentissä alkaaa 5 sekunnin ajatus, joka kertoo käyttäjälle, että peli alkaa 5 sekunnin kuluttua. | ||
| Aluksi syttyy yksi LED-valo, jonka jälkeen pelaajan tulee painaa sitä vastaavaa nappia. Jokaisen oikean painalluksen myötä LEDien syttymisnopeus kasvaa ja painalluksen odotusaika lyhenee. Jos pelaaja painaa väärää nappia tai ei paina mitään nappia annetussa ajassa, peli päättyy. | ||
|
|
||
| Jos laitetta ei käytetä yli minuuttiin, peli siirtyy virransäästötilaan, jolloin 7-segmenttinäytöt sammuvat. Tämän jälkeen joka viides sekunti yksi LED-valo vilkkuu satunnaisessa järjestyksessä. Peli poistuu virransäästötilasta, kun mitä tahansa painiketta painetaan. | ||
|
|
||
| Peli tallentaa suurimman saavutetun pistemäärän (High Score), joka näytetään 7-segmenttinäytöillä pelin lopussa sekä ennen pelin alkua. High Score tallentuu Arduino Unon EEPROM-muistiin, jolloin se säilyy tallessa, vaikka laitteesta katkaistaisiin virta. | ||
|
|
||
| High Scoren voi nollata painamalla kahta painiketta samanaikaisesti ja pitämällä niitä pohjassa kaksi sekuntia. | ||
|
|
||
| Pelissä on myös debug-tila, joka aktivoidaan Spedenspelit.ino-tiedostosta asettamalla debug-arvoksi 1. Kun debug-tila on päällä, sarjaportti (Serial) aktivoituu, ja sarjamonitorista voi seurata pelin tapahtumia: miten painikkeet, LEDit ja segmenttinäytöt alustetaan ja toimivat, sekä jokaisen pelivaiheen ja tilan tiedot, mukaan lukien painallukset ja pisteiden kirjautuminen. | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| ### Rakennettu käyttäen | ||
|  | ||
| - Arduino UNO <a href="https://docs.arduino.cc/resources/datasheets/A000066-datasheet.pdf"> Arduino Uno Datasheet</a> | ||
| - 4x Lediä <a title="LED">💡</a> | ||
| - 4x painiketta <a title="button">📥 📤</a> | ||
| - 2x 7-segmenttinäyttöä SC52-11SRWA📺 <a href="https://www.farnell.com/datasheets/2047571.pdf?_gl=1*10oxlmm*_gcl_au*OTI1ODYwNzgzLjE3MjgzMzExODQ."> SC52-11SRWA Datasheet</a> | ||
| - 2x 74HC595 serial-to-parallel muuntimia <a href="https://www.diodes.com/assets/Datasheets/74HC595.pdf"> 74HC595 Datasheet</a> | ||
|
|
||
| ## Projektin rakenne | ||
| Tässä osiossa kuvaamme projektin tiedostorakenteen ja kunkin tiedoston tarkoituksen. Päivittyy... | ||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
|
|
||
| - **/images**: Projektiin liityvät kuvat. | ||
| - **/Kooditoteutus**: Projektin kooditotutuksen lähdekoodit. | ||
| - **/Kooditoteutus/SpedenSpelit**: Speeden Spelit kooditotutuksen lähdekoodit. | ||
| - **/Konseptointi**: Projektiin liityvät konseptoinit löytyvät tästä kansiosta, kuten vuokaaviot ja kytkentäkaaviot. | ||
| - **README.md**: Tämä tiedosto, joka sisältää projektin kuvauksen, sekä suunitelman. | ||
|
|
||
| ## Suunnitelma | ||
| - OAMK:n tietotekniikan tutkinto-ohjelma kurssilla, teemme ryhmätyönä tietotekniikan sovellusprojektin opintojaksolla, jossa suunnittelemme, sekä rakennamme Speden Spelit- pelin, Arduino-mikrokontrollerilla. | ||
| - Toteutamme projektin ryhmätyönä, johon osallistuu [Aleksandr Starchenkov ,Dmitry Troshkov ,Alexey Sheykin ja Martin Negin](https://github.com/vem882/r24_speede#ryhm%C3%A4n-j%C3%A4senet). | ||
| Tarkoituksena on oppia projektien toteutusta ryhmätyönä, sekä näyttää aikaisemmilla ohjelmointi ja tietotekniikan kursseilla oppimia asioita, kuten ohjelmointi, Arduinon käsittely ja tuoda nämä opit käytäntöön projektin muodossa. | ||
| <!-- GETTING STARTED --> | ||
| ## Näin pääset alkuun | ||
| - Varmista, että sinulla on asennettuna Aruino IDE. | ||
| - Suorita kytkennät kytkentäkaavion avulla. | ||
| - Laitaa lähdekoodi repositorysta. | ||
| - Avaa lähdekoodi kansiosta Kooditoteutus/SpedenSpelit Arduino IDE:ssä | ||
| - Kytke Arduino Uno Usb-kaapelilla tietokoneen USB-portiin | ||
| - Paina Verify | ||
| - Paina Upload | ||
|
|
||
| -Jos kytkentäsi poikkeaa kytkentäkaaviosta, huomioi kytkentä pinnit. | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
| ### Vaihe 1: Konseptointi | ||
| - Pelimekaniikan suunnittelu | ||
| - Vuokaaviot | ||
| - Arduino-komponenttien määrittely | ||
|
|
||
| ### Vaihe 2: Toteutus | ||
| - Laitteiston ja ohjelmiston yhdistäminen | ||
| - Ohjelmakoodin kehittäminen | ||
|
|
||
| ### Vaihe 3: Testaus | ||
| - Pelin toiminnallisuuden testaus | ||
| - Viimeiset korjaukset ja parannukset | ||
| <!-- USAGE EXAMPLES --> | ||
| ## Käyttö | ||
|
|
||
| ### Vaihe 4: Dokumentointi | ||
| - Dokumentoidaan kaikki vaiheet, kaikki koponentit, koodit yms. | ||
| Tähän tulee esimerkit Käyttötarkoituksista ja olosuihteista. | ||
|
|
||
| ### Vaihe 5: Viimeistely | ||
| - Viimeiset korjaukset, parannukset, ennen julkaisua. | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
| ## Vuokaavio | ||
| <img src="https://github.com/vem882/r24_speede/blob/main/Konseptointi/vuokaavio.drawio.png?raw=true" width="600px;" alt=""/> | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
| ## Kytkentä | ||
| <img src="https://github.com/vem882/r24_speede/blob/main/Konseptointi/kytkentakaavio.png?raw=true" width="600px;" alt=""/> | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
| <!-- ROADMAP --> | ||
|
|
||
| ## Jatkokehitys | ||
|
|
||
| - [x] Debug | ||
| - [x] Virransäästö | ||
| - [ ] Äänet | ||
| - [ ] Highscoren tallennus verkkosivuille | ||
| - [ ] 7-Segmentti näyttöjen korvaus LCD-näytöllä | ||
| - [ ] Ensimmäisen käynistyksen asennusvalikko LCD-näytöllä, kielivalikko, asetukset. | ||
| - [ ] monikielisyys | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
| ## Top contributors: | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/AleksandrCGM"><img src="https://avatars.githubusercontent.com/u/160769064" width="50px;" alt=""/><br /><sub><b>Aleksandr Starchenkov</b></sub></a><br /><a title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/Dmitrytroshkov"><img src="https://avatars.githubusercontent.com/u/181249129" width="05px;" alt=""/><br /><sub><b>Dmitry Troshkov</b></sub></a><br /><a title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/AlexeySheykin"><img src="https://avatars.githubusercontent.com/u/181261717" width="50px;" alt=""/><br /><sub><b>Alexey Sheykin</b></sub></a><br /><a title="Code">💻</a></td> | ||
| <td align="center"><a href="https://github.com/vem882"><img src="https://avatars.githubusercontent.com/u/494950" width="50px;" alt=""/><br /><sub><b>Martin Negin</b></sub></a><br /><a title="Code">💻</a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- LICENSE --> | ||
| ## LicenLisenssise | ||
|
|
||
| Projekti lisensoitu GNU General Public License v3.0 - lisenssillä Lue lisää `LICENSE.txt`. | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- ACKNOWLEDGMENTS --> | ||
| ## Kiitokset | ||
|
|
||
| Kiitokset ja lähteet: | ||
|
|
||
| * [Choose an Open Source License](https://choosealicense.com) | ||
| * [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) | ||
| * [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/) | ||
| * [Malven's Grid Cheatsheet](https://grid.malven.co/) | ||
| * [Img Shields](https://shields.io) | ||
| * [GitHub Pages](https://pages.github.com) | ||
| * [Font Awesome](https://fontawesome.com) | ||
| * [React Icons](https://react-icons.github.io/react-icons/search) | ||
|
|
||
| <p align="right">(<a href="#readme-top">Takaisin alkuun</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/vem882/r24_speede.svg?style=for-the-badge | ||
| [contributors-url]: https://github.com/vem882/r24_speede/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/vem882/r24_speede.svg?style=for-the-badge | ||
| [forks-url]: https://github.com/vem882/r24_speede/network/members | ||
| [stars-shield]: https://img.shields.io/github/stars/vem882/r24_speede.svg?style=for-the-badge | ||
| [stars-url]: https://github.com/vem882/r24_speede/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/vem882/r24_speede.svg?style=for-the-badge | ||
| [issues-url]: https://github.com/vem882/r24_speede/issues | ||
| [license-shield]: https://img.shields.io/github/license/vem882/r24_speede.svg?style=for-the-badge | ||
| [license-url]: https://github.com/vem882/r24_speede/blob/master/LICENSE.txt | ||
| [product-screenshot]: images/V1.0/IMG_3277.jpeg |