Hello World (esimerkki sivupohjan käytöstä)

TL;DR:

Tämä sivu on konkreettinen malli siitä, miten yhtä sivupohjaa voisi käyttää jonkin projektin/palvelun/järjestelmän dokumentaationa. Ei ole sitova ohjeistus, lähinnä tarjoiluehdotus  Tämä TL;DR-osio auttaa kiireistä lukijaa päättämään, onko loppuosa sivusta vaivan arvoista lukea! 

Hello World

Hello World -järjestelmä on fiktiivinen tietojärjestelmä, joka leikisti sytyttää "Heipä hei"-neonvalokirjaimet aina kun joku avaa DigiHubin oven magneettiavaimella.

Tässä olisi hyvä kuvata systeemit sillä tasolla, että joku ko. projektia/palvelua tuntematon kollega (devaaja, PO tms) voisi saada ainakin auttavan ja alustavan kuvan aiheesta. Tarjoa riittävästi pointtereita ja yhteystietoja!

Tekninen toteutus

• Admin-liittymä, front: React.js → kaikki hallinnoijan toiminnot, mm. valojen kirkkauden ja viiveen säätö
• Back-end: Node.js
• Valotekniikka: LAMP-stack (Led, AC-virta, Muuntaja, Pihtiputaan Sähkö Oy:n rajapinta)

Kaikkien toteuttajana on ollut Valaisinhallinnon JärjestelmäKokonaisuus -tiimi (VJK). Poikkeus: LAMP-toteutus on peritty Keisarillisen Aleksanterin Yliopiston Sowelluskehitys-konsistoriumin Ohjelmoitsemis-pretoriaanilta.

Integraatiot

Oven sähkölukko välittää tiedon aktivoitumisestaan Abloy-kulunvalvontajärjestelmään:

1. Abloy 3000XL Plus -järjestelmä lähettää tiedon push-viestinä SOAP-protokollalla HY:n ESB-palveluväylälle
2. ESB konvertoi viestin REST-muotoiseksi ja lisää attribuutiksi avaimen käyttäjän sukunimen alkukirjaimen 
3. ESB lähettää tiedot REST-kutsuna Hello API:in (TODO: kuvaa tarkemmin, kysy Unto Devaajalta tarkempia speksejä!)
4. Hello-backend asettaa valobitit oikeaan asentoon Pihtiputaan Sähkön hienossa rajapintatuotteessa (joo, älä kysy, tuote oli käytössä HY:ssä jo vuonna 1976, lisätietoja tuoteomistajalta)
5. Lamppu syttyy oikean värisenä (toivottavasti; ks. kohta Huomioitavaa)

Jatkokehitys

Ota yhteyttä tuoteomistajaan.

HUOM: Toiveiden tynnyrissä on jo mm. ehdotus LAMP-stackin vaihtamisesta modernimpaan tai ainakin Pihtiputaan Sähkön rajapinnan korvaamisesta. 

Huomioitavaa (VARO NÄITÄ)

HUOM: Älä koskaan kosketa sähkölaitetta märkänä. Unto Devaajan edeltäjän Jonne Es:n työsuhde päättyi äkillisesti ja valitettavasti tähän liittyvissä olosuhteissa. 

Parasta ennen: 31.03.2020

• • TL;DR:
  • Hello World
  • Tekninen toteutus
  • Integraatiot
  • Jatkokehitys
  • Huomioitavaa (VARO NÄITÄ)