/SCEGGRAPH_Hackathon

Remote hackathon held for SJSU students, hosted by ACM SIGGRAPH Student Chapter and SCE of SJSU

Primary LanguageJavaScriptMIT LicenseMIT



SCEGGRAPH Hackathon: Happy Household

Remote hackathon held from 1/8/21-1/10/21 for SJSU students, hosted by ACM SIGGRAPH Student Chapter and SCE of SJSU.

Description

The purpose of Happy Household was to develop a better way of connecting people through virtual means: we aimed to solve some common issues that arise in our household as roommates.

One such issue is keeping track of whose turn it is to take out the trash. Solving this issue is especially helpful in households or dorms with multiple roommates and also encourages a fair and balanced chore routine.

Another one of these issues includes a disorganized shopping list. When someone goes out to shop or buy food for the household, there is a potential for forgetting certain items due to the messy nature of how these situations are typically handled; some examples of this messy nature include how certain requests can be drowned out by irrelevant text history and also simply the lack of a written medium to store the shopping list.

Happy Household helps to centralize helpful household data on the cloud that can be simulataneously accessed by multiple people through Discord, and can be arguably more effective in connecting people compared to traditional means.

Happy Household is also designed with IoT integration in mind, having developed a prototype for a wireless embedded system that can interact with the Discord bot only with a USB 5v power supply and WiFi.

In terms of challenges, Chris felt that relearning Javascript was definitely the biggest challenge. He has worked a bit with JavaScript before, but a lot of that was based on front-end React. He has also never worked with Discord bots, so learning how to do familiarize himself with Discord.js was a challenge as well.
For Vincent, the largest challenge that he faced was working with the wireless tech and integrating the hardware with the Discord bot. Vincent had to work with C, JavaScript, and a bit of HTTP, of which JavaScript and HTTP were completely new to him. Vincent also ran into many hardware-based road bumps along the way, like having to work around the excessive current draw of the ESP8266 WiFi board by using a questionably soldered USB 5v connector.

Project Team Members

Vincent Saw - GitHub | LinkedIn
Christopher Tom - GitHub | LinkedIn

Demonstrations

All available bot commands


A demonstration of the list commands


A demonstration of the chores commands


Photo of the wireless embedded system


Video demonstration of the wireless embedded system

Video Link

Tech/Framework

Quick Links

SCEGGRAPH Hackathon Page
Discord.js Guide
ATMega328p Datasheet
Nokia 5110 Datasheet
ESP8266 ESP-01 Datasheet

License

License: MIT
This project utilizes the MIT License.

Copyright © 2021 Vincent Saw and Christopher Tom

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.