Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Hub Developer Getting Started Guide
# Hub and Core System
Go codebase
## Hub Team Features Demo Video link

[Video for Presentation Day Hub Team Demo](https://drive.google.com/file/d/1KnHlDSw1Z77iP68RljKhooetPIYsfUyf/view?usp=sharing)
<br/>

## Hub Developer Getting Started Guide

1. If you do not already have the smartess_network set up on docker, in the main directory "Smartess" run:

Expand Down Expand Up @@ -77,7 +84,6 @@ Methods to: Marshall into configStructs from yaml-config , then from configstruc
### common/structures
Common data structures, Entities, Contexts, States, EntityFormats structs \
Also lot of HA specific structs and interfaces, as well as relevant enums for go codebase \
[WIP] TODO: Eventually have proper models/structs distinguishable between 'server' and 'hub'

## hub/
Any scripts, configs, utilities specifically related to the Hub service \
Expand All @@ -88,7 +94,7 @@ Any scripts, configs, utilities specifically related to the Hub service \
. RabbitMQ Publishers and publisher-side exchanges \
. WebSocket... hub app ports, hub IP; Networking, phys con, virtual chans, hosts, RabbitMQ Dialer \
. Different Connection setups and webhooks: production or dev Hub is RPI/HA, dev or test Hub is mockups \
. [WIP] Token, Authentification, security, data/connection integrity,
. [Open to scale] Token, Authentification, security, data/connection integrity,

. Hardware installation scripts and docs \
. RTSP video streaming feature (core networking and logic) \
Expand All @@ -99,9 +105,9 @@ Any scripts, configs, utilities specifically related to the Hub service \
Any scripts, configs, utilities specifically related to the Backend service \
.RabbitMQServer (RabbitMQInstance, logger, consumers, exchanges, bindings) Init() and Start() \
.RabbitMQ Consumers and Consumer-side Exchanges setup \
. [WIP] Microservices and Managers \
. [WIP] Model & Orchestrator logic to manage and containrize microservices \
. [WIP] Data,Persistence, Microservice, Managers and Business logic to service frontend-apis/views \
. [Open to scale] Microservices and Managers \
. [Open to scale] Model & Orchestrator logic to manage and containerize microservices \
. Data,Persistence, Managers and Business logic to service frontend-apis/views \

# Dependencies and Design from Wikis
For Go, RabbitMQ, Docker, and other dependencies, see the Architecture wiki and Infrastructure and Tools wikis. \
Expand Down Expand Up @@ -163,7 +169,7 @@ Docker-composes and Dockerfiles should be commented and clear enough to understa
| enums.go
|
+---hub
| | hub_daemon.go (Formerly hub.go)
| | hub_daemon.go (Formerly hub.go, Main producer driver)
| |
| +---config
| | config.yaml
Expand All @@ -187,8 +193,10 @@ Docker-composes and Dockerfiles should be commented and clear enough to understa
+--- README.md
|
\--- rabbitmq
consumer.go
rabbitmq.go
\--handlers/ (Consumer handlers and middlewars before website/smartess APIs: Events, alerts, logging, Video controller/muxer/segmenter)
\--static/ (Server side version of pages for scripts and to see alerts or video only)
|
rabbitmq.go (main consumer driver)
....
....
```
4 changes: 4 additions & 0 deletions go/hub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,7 @@
```
### Smartess HUB installation
## Proper simplified bash scripts and HA settings pulled sirectly from repo to come

## Screenshot Video Surveillance
![image](https://github.com/user-attachments/assets/d5c126f8-e09b-4aa2-a4c8-bb0c805bf7c5)

Loading