|
|
|
## Technical documentation
|
|
|
|
|
|
|
|
Version number 0.0.25
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
|
|
We are making a virtual friend concept that is a path or an environment for hospitals. This document gives the future developers an idea of what technologies have been used.
|
|
|
|
|
|
|
|
The project's basis is to create a prototype of a virtual friend that could be used in a hospital so children's fears are reduced during their stay. The project is done as part of WIMMA Lab at Jyväskylä Univesity of Applied Sciences by the company IoTitude.
|
|
|
|
|
|
|
|
|
|
|
|
## General description
|
|
|
|
|
|
|
|
The project's goal is to create a tool that reduces 4-6 year old chidren's fears during their stay at the hospital. To accomplish this goal, the tool utilizes tracking the child's distance from specific terminals and displays different views on them accordingly.
|
|
|
|
|
|
|
|
## Used technologies
|
|
|
|
|
|
|
|
### General technologies
|
|
|
|
* Ubuntu 18.04
|
|
|
|
* Windows 10
|
|
|
|
* Visual Studio Code 1.23.1
|
|
|
|
* Git 2.17.0
|
|
|
|
|
|
|
|
### Front-end ("the game")
|
|
|
|
* MonoGame 3.6
|
|
|
|
* MonoDevelop 6.2
|
|
|
|
* Visual Studio Community 2017 15.7.5
|
|
|
|
|
|
|
|
### Back-end
|
|
|
|
* gRPC 1.12.2
|
|
|
|
* Node.js 8.10.0
|
|
|
|
* Python 2.7.12
|
|
|
|
* Docker 18.05.0-CE build f150324
|
|
|
|
* MySQL 5.7.22
|
|
|
|
|
|
|
|
### IoT technologies
|
|
|
|
* RuuviTag
|
|
|
|
|
|
|
|
|
|
|
|
## Descriptions of development environments
|
|
|
|
|
|
|
|
The tool works in a closed environment.
|
|
|
|
|
|
|
|
* Development environment
|
|
|
|
- Code is written using Visual Studio, Visual Studio Code and Monodevelop
|
|
|
|
- Version management is done using GitLab
|
|
|
|
* Testing environment
|
|
|
|
- SonarQube
|
|
|
|
|
|
|
|
|
|
|
|
## Database description
|
|
|
|
|
|
|
|
The database current consists of 4 tables (items, profileitems, profiles and tags). Only two of the tables, profiles and tags, are used. Those tables contain the following data:
|
|
|
|
|
|
|
|
#### Profiles
|
|
|
|
| Title | Data type | Description |
|
|
|
|
|--|--|--|
|
|
|
|
| id | int(11) | |
|
|
|
|
| name | varchar(255) | Name given to the character |
|
|
|
|
| avatar | varchar(255) | Character's sprite |
|
|
|
|
| lastused | datetime | When profile was last used |
|
|
|
|
| createdAt | datetime | When profile was created |
|
|
|
|
| updatedAt | datetime | When profile was last updated |
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
| Title | Data type | Description |
|
|
|
|
|--|--|--|
|
|
|
|
| id | int(11) | |
|
|
|
|
| mac | varchar(255) | RuuviTag's mac address |
|
|
|
|
| createdAt | datetime | When tag info was added |
|
|
|
|
| updatedAt | datetime | When tag info was last updated |
|
|
|
|
| profileId | int(11) | Foreign Key referring to what profile is tied to the tag |
|
|
|
|
|
|
|
|
## Test results
|
|
|
|
|
|
|
|
Tests do be done. |
|
|
\ No newline at end of file |
