Update README.md
This commit is contained in:
Untriex Programming
GitHub
parent
30535df37a
commit
61fcc5a0f7
102
README.md
102
README.md
@ -45,11 +45,109 @@ Install:
|
||||
- If you want to use computer vision plugin with rpi camera set `ENABLE_COMPUTER_VISION_PLUGIN=0` to `ENABLE_COMPUTER_VISION_PLUGIN=1` (*recommended only on RPI4)
|
||||
- If you want to use RPI as access point to WikiSpot change `#AUTO_SETUP_INSTALL_SOFTWARE_ID=60` to `AUTO_SETUP_INSTALL_SOFTWARE_ID=60`
|
||||
- *wifi setup in testing*
|
||||
5. :grey_exclamation:For advanced users:grey_exclamation: You can now change contens of WikiSpot server in `/boot/WikiSpot`according to an example (*coming soon*)
|
||||
5. :grey_exclamation:For advanced users:grey_exclamation: You can now change contens of WikiSpot server in `/boot/WikiSpot`according to an example in server filesystem
|
||||
6. Eject sd card from computer, insert it in Raspberry Pi and power it on. :bangbang:Raspberry Pi needs to be connected to intenet via Ethernet (*wifi coming soon*) othervise the setup will crash.
|
||||
7. The setup will take approximately 25-40 min (RPI 4b (2gb) and 70 mb download speed)
|
||||
8. Done you can start using WikiSpot and edit contents of WikiSpot with our app (*coming soon*)
|
||||
|
||||
### Script install
|
||||
*coming soon*
|
||||
|
||||
### Manual install
|
||||
*coming soon*
|
||||
|
||||
## Server filesystem
|
||||
```
|
||||
└── test_directory
|
||||
├── cache # files forwarded from another servers to client
|
||||
├── engine.py # engine for server (log, recovery, update)
|
||||
├── files # content of WikiSpot server
|
||||
│ └── test.jpg
|
||||
├── filesystem.json # data settings of server (name, description, files)
|
||||
├── main.py # main server file
|
||||
├── plugins # plugins file
|
||||
│ └── computer_vision # oficial WikiSpot computer vision plugin for RPI 4
|
||||
│ ├── MobileNetSSD_deploy.caffemodel
|
||||
│ ├── MobileNetSSD_deploy.prototxt
|
||||
│ └── com_vision.py
|
||||
├── run.py # start script for server
|
||||
├── settings.json # settings (log, debug, connected WikiSpots, cache size,...)
|
||||
├── system.py # update and clean script
|
||||
└── version.json # version of WikiSpot
|
||||
```
|
||||
|
||||
### filesystem
|
||||
```
|
||||
{
|
||||
"ID": 0, # ID of WikiSpots, Needs to be different, because network will crash
|
||||
"location": "25.997417761947318, -97.15738221291177", # Location of WikiSpot server copied from google maps
|
||||
"description": {
|
||||
"title": "WikiSpot demo", # Name of WikiSpot server (swiming pool, school, ...)
|
||||
"description_s": "This is showcase of WikiSpot", # Short description showed on web/app in list of servers
|
||||
"description_l": "This will show after opening server in app", # Long description showed after opening the server in web/app
|
||||
"photo_s": "test.jpg", # Small image showed on web/app in list of servers
|
||||
"photo_b": "test.png" # Big image showed after opening the server in web/app
|
||||
},
|
||||
"files": [ # files on server in /files that will be mediated to the web/app
|
||||
{
|
||||
"name": "test", # Name of the file, without spaces. App will change "_" to spaces
|
||||
"format": ".jpg", # Format of the file
|
||||
"description": "This is test file" # Description showed next to the file
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
To manualy add new file to server (on setup or via ssh) add file to `server_directory/files`
|
||||
and add record for file into `files` list in `filesystem.json`. :exclamation:do not forget "," after last record:exclamation:
|
||||
```
|
||||
|
||||
{
|
||||
"name": "new_file_name",
|
||||
"format": ".txt",
|
||||
"description": "This is how you add new file"
|
||||
}
|
||||
```
|
||||
|
||||
### settings.json
|
||||
```
|
||||
{
|
||||
"time_to_heartbeat": 20, # Time to ping of another online servers in seconds
|
||||
"time_to_heartbeat_offline": 25, # Time to ping of another offline servers in seconds
|
||||
"save_table": true, # Save connected servers to reconnect after restart
|
||||
"time_to_save": 60, # Time to save server in seconds
|
||||
"max_mess": 20, # Maximum messages stored in RAM
|
||||
"cache_size_mb": 1000, # Maximum size of cache directory in mb
|
||||
"clear_cache_on_startup": false, # Remove contents of cache on startup (slower first downloads)
|
||||
"log": { # Log settings
|
||||
"save_error": true, # Save errors into log.txt
|
||||
"print_error": true, # Print errors into console (if running as service into linux log)
|
||||
"save_warning": true, # Save warnings into log.txt
|
||||
"print_warning": true, # Print warnings into console (if running as service into linux log)
|
||||
"save_message": false, # Save messages (new server, etc. not messages from clients) into log.txt
|
||||
"print_message": true, # Print messages into console (if running as service into linux log)
|
||||
"enable_debug": false # Enable debug into console (if running as service into linux log)
|
||||
},
|
||||
"heartbeat_table": { # Saved servers
|
||||
"ID": [],
|
||||
"IP": [],
|
||||
"location": [],
|
||||
"file_system": [],
|
||||
"last_heartbeat": []
|
||||
}
|
||||
}
|
||||
```
|
||||
If you want to manually add server on first setup or via ssh fill heartbeat table like this.
|
||||
```
|
||||
"heartbeat_table": { # Saved servers
|
||||
"ID": [1], # ID of server as integer (number)
|
||||
"IP": ["192.168.1.2"], # IP of server as string
|
||||
"location": [""], # Empty string as placeholder. location will be downloaded after first connection
|
||||
"file_system": [""], # Empty string as placeholder. filesystem will be downloaded after first connection
|
||||
"last_heartbeat": [10] # After how many seconds will server try to connect for the first time
|
||||
}
|
||||
```
|
||||
:bangbang:If the server will be offline for long time (heartbeat + offline heartbeat) it will be removed from heartbeat table. If the save function is disabled server will trying to connect after restart:bangbang:
|
||||
|
||||
|
||||
This is not finished product
|
||||
|
||||
*This is not finished product*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user