Update documentazione!!!

This commit is contained in:
Samuele E. Locatelli
2019-08-02 12:13:31 +02:00
parent d198a0f47e
commit 96215da7cc
4 changed files with 48 additions and 3 deletions
+14 -1
View File
@@ -6,6 +6,7 @@ Progetto per l'implementazione del server OPC-UA di gruppo basato su REDIS per a
- [SOUR (SCM OPC-UA REDIS)](#sour-scm-opc-ua-redis)
- [Organizzazione documenti e codice](#organizzazione-documenti-e-codice)
- [MQTT](#mqtt)
- [MSI installer](#msi-installer)
- [Versioni](#versioni)
@@ -15,13 +16,25 @@ Progetto per l'implementazione del server OPC-UA di gruppo basato su REDIS per a
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| images | Files supporto documentazione |
| LogConversion | Gestione conversione traccaito di LOG SOUR in formato leggibile per MSIM (superato da versioni > 1.*) |
| Rilasci | Folder dei rilasci (in versione release/debug) del server SOUR |
| Rilasci | Folder dei rilasci (in versione release/debug) del server SOUR, IN PHASE OUT con impiego del nuovo server NEXUS |
| Specifiche.pdf | File contenente le specifiche di interfaccia per SOUR (che devono essere note ai vari Adapters) e tutte le definizioni a livello di interfaccia |
| Specifiche.md | File sorgente (in formato Markdown) delle specifiche |
| src | Folder contenente i sorgenti di SOUR |
| TestClients | Client di riferimento per testing funzionalità OPC-UA |
| Utility | script ed utility varie |
| Varie | Documentazioni ed esempi a corredo |
| Video | Brevi demo dell'utilizzo |
## MQTT
Dalla versione 2.2 è attivo un broker di pubblicazione MQTT verso il cloud.
Condizioni necessarie al funzionamento:
- Non sia presente la chiave di vet in REDIS all'indirizzo `SOUR:GwHw:Vers`, se vuoto/nullo = nessun veto, se presente il numero di versioni (o anceh solo una stringa non vuota) riferita al Gateway Hw viene inibito il funzionamento della sezione MQTT
- macchina attivata con SDK (quindi disponibili le informaizoni di user e pwd per il broker)
## MSI installer
Aggiunto il progetto di generazione installer con wix, il processo jenkis crea l'installer come ultimo step di deploy
BIN
View File
Binary file not shown.
+34 -2
View File
@@ -12,12 +12,15 @@ Progetto per l'implementazione del server OPC-UA di gruppo basato su REDIS per a
- [Requisiti per installazione](#requisiti-per-installazione)
- [Regole di Naming](#regole-di-naming)
- [Schemi di dettaglio](#schemi-di-dettaglio)
- [Riferimenti importanti](#riferimenti-importanti)
- [MQTT](#mqtt)
- [MSI installer](#msi-installer)
- [Elementi della soluzione](#elementi-della-soluzione)
- [SPECIALIZED ADAPTER --> REDIS SERVER](#specialized-adapter----redis-server)
- [OPC-UA SERVER --> REDIS SERVER](#opc-ua-server----redis-server)
- [DataModel](#datamodel)
- [Riferimenti per il server OPC-UA](#riferimenti-per-il-server-opc-ua)
- [Modalità di funzionamento SOUR](#modalit%C3%A0-di-funzionamento-sour)
- [Modalità di funzionamento SOUR](#modalit%c3%a0-di-funzionamento-sour)
- [Dettaglio struttura memoria DB del server REDIS](#dettaglio-struttura-memoria-db-del-server-redis)
- [Adapter - Adp](#adapter---adp)
- [Adapter - AdpConf](#adapter---adpconf)
@@ -27,7 +30,7 @@ Progetto per l'implementazione del server OPC-UA di gruppo basato su REDIS per a
- [Adapter - MConnect](#adapter---mconnect)
- [Dettaglio protocollo comunicazione HMI - Maestro Connect](#dettaglio-protocollo-comunicazione-hmi---maestro-connect)
- [Aspetti tecnici salienti](#aspetti-tecnici-salienti)
- [Schema Funzionalità](#schema-funzionalit%C3%A0)
- [Schema Funzionalità](#schema-funzionalit%c3%a0)
- [**ChannelsIN**: notifica info dal Cloud / richiesta esecuzione task -> HMI](#channelsin-notifica-info-dal-cloud--richiesta-esecuzione-task---hmi)
- [Caso duso ChannelsIN:DataError](#caso-duso-channelsindataerror)
- [Caso duso ChannelsIN:AlertHMI](#caso-duso-channelsinalerthmi)
@@ -62,6 +65,10 @@ Le versioni rilasciate della documentazione e del server SOUR sono le seguenti:
| 1.2.6 | 2018.12.06 | Completata documentazione area REDIS e aggiornamento server (1.2.1812.185) |
| 1.3.1 | 2019.01.31 | Implementata gestione nuovi parametri in DataModel per SampleGroup, DeadBand, VisibilityGroup --> testing con FANUC/SIEMENS ed adapter CMS (1.3.1901.195) |
| 1.3.2 | 2019.02.03 | Review documentazione x definizione modelli tracciati JSON per log eventi/allarmi/produzione su base riunione 2018.01.30 (1.3.1902.196) |
| 1.4 | 2019.02.18 | Cambio Namespace, fix gestione allarmi |
| 2.0 | 2019.03.08 | Prima release 2.0 stabile |
| 2.1 | 2019.04.12 | modifica comportamento in avvio per sincronizzazione allarmi, sincronizzazione variabili e proprietà |
| 2.2 | 2019.08.01 | Prima release 2.2 con MQTT, fix comportamento invio allarmi 8gestione memoria persistente precedente invio stato allarmi), nuovo installer MSI |
<div style="page-break-after: always;"></div>
@@ -186,6 +193,31 @@ A valle di questo si trova il server REDIS che persiste le informaizone e fa da
<div style="page-break-after: always;"></div>
## Riferimenti importanti
Alcune note importatnti riguardo l'installer MSI di SOUR e il broker MQTT embedded in SOUR
### MQTT
Dalla versione 2.2 è attivo un broker di pubblicazione MQTT verso il cloud.
Condizioni necessarie al funzionamento:
- Non sia presente la chiave di vet in REDIS all'indirizzo `SOUR:GwHw:Vers`, se vuoto/nullo = nessun veto, se presente il numero di versioni (o anceh solo una stringa non vuota) riferita al Gateway Hw viene inibito il funzionamento della sezione MQTT
- macchina attivata con SDK (quindi disponibili le informaizoni di user e pwd per il broker)
### MSI installer
Aggiunto il progetto di generazione installer con wix, il processo jenkis crea l'installer come ultimo step di deploy
Modalità di installaizone file installer msi:
```powershell
SOUR.Setup.msi INSTALLFOLDER=C:\IOT\SOUR /quiet
```
## Elementi della soluzione
Di seguito sono indicati i vari elementi in gioco nel sistema e le specifiche di impiego e funzionamento.
BIN
View File
Binary file not shown.