search

hjoon0510 / SmartSecretary

:partly_sunny: [KOI 2018] SmartSecretary tells users current weather and important schedule in front of door as a secretary.
Other
2 stars 1 forks source link

readme

What is Smart Secretary?

This program informs users of current weather and important schedules as a personal secretary in the morning everyday in front of a door.

Motivation

Unfortunayely, modern people can not keep their umbrellas on a rainy day because of busy daily life, and often leave the house. So when the weather you know is often going out, it often changes. People are very busy in the morning. As a result of that, they do not finally bring their important schedules in front of door. From our experiecne, we often do not remember things or schedules we need to pack in the morning. Therefore, we need to get a personal assistant to solve these problems. We named Smart Secretary (SS). The recommended pronunciation is "double s" to minimize your inconvenience because of long project name.

Requirement

First of all, you have to prepare hardware and software as follows.

Hardware

Smart Secretary (SS) provides an intelligent facility to assist a busy modern people. It is developed with popular embedded device Raspberry Pi3 board. We also bought a PIR motion sensor to probe a movement of a hunman being.

Software

Thanks to Linux kernel, We could easily set-up a free operating systems (OS) that is called Ubuntu OS, Raspbian OS on our Raspberry Pi3 board.

Programming languages

Our program is developed by Python, PHP, and HTML language.

Design

The figure below shows an entire operation sequence of our solution. First of all, this program gets a necessary information from web API servers such as weather and fine dust. The program then uses the PIR motion sensor to detect human motion exactly. When a person comes around the Raspberry Pi3 board, Smart Secretary only prints important information on the screen, but also speaks by voice for busy modern people. Users can also check the important schedule(you can show schedule thanks to google calendar API service) before leaving home. In the event of rain, users can check the weather information in real time using e-mail.

How to install

Install Ubuntu OS in Raspberry Pi3

First of all, read documents that we uploaded in doc folder. Then, please try to install Ubuntu OS in Raspberry Pi3 device.

Install Smart Secretary

Smart Secretary was mainly developed by Python (motion sensor) and PHP (Web application). Please install two applications as following:

Run ssh session with mobaxterm software on windows7 PC.
$ cd /var/www/html
$ git clone https://github.com/hjoon0510/SmartSecretary.git
$ cd ./SmartSecretary 
$ sudo chown -R www-data:www-data /var/www/html/SmartSecretary/webpage/data/
$ sudo visudo
--------------- /etc/sudoers: start ----------------
# User privilege specification
root    ALL=(ALL:ALL) ALL
hjoon0510       ALL=NOPASSWD: ALL <-- Please append your id here.!!!!
--------------- /etc/sudoers: ending ---------------

How to run

This section describes how to start web-application and pir-sensor program.

Run software manually

Run software at boot-time automatically

If you want to start automatically chromium-browser in full screen mode at boot time, Please append new program to the list of startup program on Startup Applications windows as follows. 

* Ubuntu - System - Preference - Personal - Startup Applications

* Smart Secretary (web-app)
   * Name: Smart Secretary (webapp)
   * Command: chromium-browser http://localhost/SmartSecretary/ --start-fullscreen
   * Comment: none

* Smart Secretary (pir-sensor)
   * Name: Smart Secretary (pir-sensor)
   * Command: /var/www/html/SmartSecretary/motion/pir-sensor.py
   * Comment: none

The above icons are saved in the ~/.config/autostart/ folder. Alternatively, you can append your terminal commands in /etc/init.d/rc.local, and it will also automatically execute upon boot.

Demonstration

Reference

Terminology

Translation

We make an effort to write english statement by utilizing https://translate.google.com to talk about the Smart Secretary project with foreign students all over the world. If you are not student that can not speak in english such as us, we recomend that you try to use https://translate.google.co.kr/?hl=ko#en/ja/https%3A%2F%2Fgithub.com%2Fhjoon0510%2FSmartSecretary for your convenience.

Contact

My name is Hyunjun Lim (임현준 in korean). I am a student in Maetan middle-school. My homepage is http://hjoon0510.github.io. Also, I am project leader for Smart Secretary. If you have any questions, Please contact me hjoon0510@gmail.com.

My name is Suyeon Lim (임수연 in korean). I ma a student in Maeheon middle-school. My homepage is https://lsy0314.github.io/. If you have any questions, Please do not hesitate to contact me lsy0314@gmail.com.

License

The official license of Smart Secretary is Star License. For more details, please read Star License clause.