Fix readme progetto con grafici e descrizioni necessarie
This commit is contained in:
Samuele Locatelli
@@ -2,91 +2,214 @@
|
||||
|
||||
Progetto custom applications x fiera Xylexpo, demo del sistema NKC (adeguatamente semplificato)
|
||||
|
||||
## Getting started
|
||||
## Cosa vogliamo presentare
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
Vogliamo presentare qualcosa di diverso/avanzato, aprtendo da NKC come "pezzo forte"... olvviamente presenteremo tutti i prodotti standard
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
## Prodotti standard
|
||||
|
||||
## Add your files
|
||||
- EgtCAM
|
||||
- MAPO MES
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
## Prodotti custom
|
||||
- BeamWall
|
||||
- Marmo
|
||||
- GWMS
|
||||
- GPW
|
||||
- CTRACK
|
||||
- ...
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://gitlab.steamware.net/egalware/xylexp.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
## NKC / Xyl.EXP
|
||||
|
||||
## Integrate with your tools
|
||||
Nome forse migliorabile...
|
||||
|
||||
- [ ] [Set up project integrations](https://gitlab.steamware.net/egalware/xylexp/-/settings/integrations)
|
||||
Per la fiera è previsto gestione ibrida:
|
||||
* esecuzione su server locale in fiera
|
||||
* integrazione con server in cloud (OVH/ufficio) x accesso dati da esterno
|
||||
|
||||
## Collaborate with your team
|
||||
## RoadMap / USE case da realizzare
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
Abbiamo quindi il seguente schema logico di massima che vorremo realizzare, ujna simualzione dio un intero processo produttivo con MES, CAD/CAM/CNC, ...
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
Devono esserci prodotti/gadgets/items in display x spiegare che c'è un "gioco/demo" che prevede il gadget finale, in cambio della presentazione (a grandi linee) del prodotto e del processo garantito dal prodotto.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
| Fase | Tema | Note |
|
||||
|--------------|-----------|------------|
|
||||
| 1. Enroll | Security / profilazione | Semplicità / sicurezza / rapidità |
|
||||
| 2. ODL Creation | Gestione ordini (creazione) | Possibilità di creare anche ordini singoli |
|
||||
| 3. Monitor | Monitoraggio | Funzionalità di analisi / accorpamento, capacità di riassumere stato ordini, rapido e completo |
|
||||
| 4. Scheduler/Processing | Schedulazione ordini + Processing CAD/CAM/... | Gestione altamente specializzata di fasi CAD/ottimizzazione/nesting |
|
||||
| 5. POST Processing | CAM e Generazione automatica programmi | Produzione di programmi custom |
|
||||
| 6. Production | Simulazione (DigitalTwin) e produzione items | Visualizzazione fase di Produzione, acquisizione dati |
|
||||
| 7. Delivery | Customizzazione finale prodotto + QR card univoca | Realizzazione finale con produzione della card con QR code che fa da certificato del processo |
|
||||
|
||||
***
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
# Editing this README
|
||||
### Fase 1: Enroll
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
Personale Egalware deve accogliere e supportare la fase di enroll iniziale, in cui vogliamo collezionare dati utente come
|
||||
|
||||
## Suggestions for a good README
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
* Generalità (cognome/nome)
|
||||
* Azienda
|
||||
* Email
|
||||
* Cellulare (opzionale)
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
Se avremo wifi locale x enroll, supporto x login wifi & raccolta info
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
@startuml
|
||||
database Enroll
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
User -> (Arriva allo Stand)
|
||||
User ---> (Enroll) : Compila Form
|
||||
:EgalWare: --> (Enroll) : Fornisce supporto\nper enroll
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
@enduml
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
### Fase 2: ODL Creation
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
Personale Egalware deve supportare la fase di creazione ordine (es selezione gadget, formati, info...).
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
Si deve scegliere
|
||||
* gadget finale
|
||||
* forma contenitore (a scelta in set)
|
||||
* testo da scrivere
|
||||
* eventuali altre immagini
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
nb: avremo plotting, evitare figure "piene"
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
@startuml
|
||||
collections ODL
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
User ---> ODL: generazione ODL (1+)\n(gadget, testo, grafica)
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
:EgalWare: --> ODL : Fornisce supporto per \n(enroll, ODL)
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
@enduml
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
### Fase 3: Monitor
|
||||
|
||||
Lo scopo è spiegare le regole del gioco delal schedulazione
|
||||
* comporre tanti piccoli ordini in un ordine + grande
|
||||
* ottimizzare impiego materiale (nesting) e tempi/costi
|
||||
* possibilità di inserire "fake orders" x velocizzare
|
||||
|
||||
@startuml
|
||||
|
||||
component ODL $tag13
|
||||
cloud EgtCAM5
|
||||
|
||||
rectangle MES {
|
||||
ODL --> (Coda Ordini)
|
||||
(Coda Ordini) <--> (Accorpamento)
|
||||
(Accorpamento) <--> (Scheduler)
|
||||
(Scheduler) <--> EgtCAM5: calcoli + generazione\nfile CNC, NGE, SVG,...
|
||||
}
|
||||
(Accorpamento) ---> User : Notifica
|
||||
:EgalWare: --> (Accorpamento) : Group / Split
|
||||
|
||||
@enduml
|
||||
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
### Fase 4: Scheduler/Processing
|
||||
|
||||
Tipica fase di MES avanzato con integrazione CAD/CAM
|
||||
|
||||
@startuml
|
||||
|
||||
cloud EgtCAM5
|
||||
|
||||
rectangle MES {
|
||||
|
||||
(Scheduler) <--> EgtCAM5: calcoli + generazione\nfile CNC, NGE, SVG,...
|
||||
}
|
||||
(Scheduler) ---> User : Notifica
|
||||
|
||||
@enduml
|
||||
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
### Fase 5: POST Processing
|
||||
|
||||
Qui il CAD/CAM si occupa di post processare e produrre ogni file necessario.
|
||||
|
||||
Nel caso reale
|
||||
* File CNC x stampa
|
||||
* file CNC x taglio
|
||||
* file SVG x visualizzazioni
|
||||
* dati REST di calcolo verso sistema MES centrale (tempi/materiali, rese...)
|
||||
|
||||
Nel nostro caso
|
||||
* file NGE x simulatore DigitalTwin equivalente al CNC di taglio
|
||||
* file (svg) per macchina taglio
|
||||
* dati REST di calcolo verso sistema MES centrale (raccolta info documentale)
|
||||
|
||||
@startuml
|
||||
|
||||
cloud EgtCAM5
|
||||
database MES
|
||||
|
||||
(EgtCAM5) --> (File SIM): SIM\nDigital Twin
|
||||
(EgtCAM5) --> (File Macchina): Produzione\ngadget
|
||||
(EgtCAM5) --> (MES): Info Produzione
|
||||
|
||||
@enduml
|
||||
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
### Fase 6: Production
|
||||
|
||||
Gli operatori Egalware devono
|
||||
* prende i file svg prodotti da EgtCAM
|
||||
* selezioanre layer print e cut x apparato reale
|
||||
* avviare processing (macchina + DigitalTwin)
|
||||
|
||||
@startuml
|
||||
|
||||
database MES
|
||||
node Display
|
||||
node Vinile
|
||||
|
||||
MES --> (DigitalTwin): Iso x simulazione
|
||||
DigitalTwin --> Display: 3D SIM
|
||||
|
||||
MES --> (PrintCut): SVG x stampa e taglio
|
||||
PrintCut --> Vinile: gadget
|
||||
|
||||
@enduml
|
||||
|
||||
<div style="page-break-after: always;"></div>
|
||||
|
||||
### Fase 7: Delivery
|
||||
|
||||
Qui si consegna il gadget al cliente ed il certificato con etichetta e si verifica che il QRcode + email riportano le info del processo avvenuto, ad esempio
|
||||
|
||||
* Codice univoco ODL
|
||||
* DataOra registrazione ODL
|
||||
* Dati ODL
|
||||
* DataOra inizio scheduling
|
||||
* DataOra inizio produzione
|
||||
* DataOra fine produzione
|
||||
|
||||
@startuml
|
||||
|
||||
database MES
|
||||
node Vinile
|
||||
node PrintQR
|
||||
cloud Web
|
||||
|
||||
MES ---> PrintQR: stampa certificato QR
|
||||
PrintQR ---> Web: info server
|
||||
PrintQR ---> User: email
|
||||
|
||||
|
||||
Vinile --> (Gadget): Applicazione gadget
|
||||
Gadget --> User: Consegna
|
||||
|
||||
@enduml
|
||||
|
||||
BIN
Binary file not shown.
Reference in New Issue
Block a user