piermesh/docs/run.md

159 lines
2.9 KiB
Markdown
Raw Normal View History

2024-08-01 01:00:46 +00:00
# run: PierMesh service runner
2024-07-28 11:21:15 +00:00
### *class* run.Node
2024-08-01 01:00:46 +00:00
Class that handles most of the PierMesh data
2024-07-28 11:21:15 +00:00
[🔗 Source](https://git.utopic.work/PierMesh/piermesh/src/branch/main/src/run.py)
2024-07-29 14:13:56 +00:00
#### toLog
We store logs to be processed here
* **Type:**
list
#### actions
Dictionary mapping methods with the action prefix to the method name after action dynamically to be called through Sponge (Sponge.base) filtering
* **Type:**
dict
#### todo
List of actions to execute
* **Type:**
list[dict]
#### network
Network map
* **Type:**
Network
#### catch
Daisy cache for catchs, our domain analog
* **Type:**
Catch
#### cache
Daisy cache for general use
* **Type:**
Cache
#### nodeInfo
Daisy (Components.daisy.Daisy) record containing some information about the node
* **Type:**
2024-08-01 01:00:46 +00:00
[Daisy](/PierMesh/piermesh/src/branch/main/docs/Daisy/Daisy.md#Daisy.Daisy.Daisy)
2024-07-29 14:13:56 +00:00
#### onodeID
PierMesh node ID
* **Type:**
str
2024-08-01 21:09:50 +00:00
#### oTransceiver
2024-07-29 14:13:56 +00:00
2024-08-01 21:09:50 +00:00
LoRa transceiver Transceiver
2024-07-29 14:13:56 +00:00
* **Type:**
2024-08-01 21:09:50 +00:00
[Transceiver](/PierMesh/piermesh/src/branch/main/docs/Transceiver/Transceiver.md#Transceiver.Transceiver.Transceiver)
2024-07-29 14:13:56 +00:00
#### processed
List of IDs of already completed messages so that we dont reprocess messages
* **Type:**
list
#### proc
This process (psutil.Process), used for managing and monitoring PierMesh
* **Type:**
psutil.Process
#### mTasks
Dictionary of PierMesh service tasks
* **Type:**
dict
#### SEE ALSO
`logPassLoop`
: Loop to handle logging to file and TUI
2024-07-28 11:21:15 +00:00
#### *async* action_initNodeDH(data: dict)
Initialize diffie hellman key exchange
#### SEE ALSO
2024-08-01 01:00:46 +00:00
`Cryptography.DHEFern.DHEFern`
2024-07-28 11:21:15 +00:00
: End to end encryption functionality
#### *async* action_keyDeriveDH(data: dict)
Derive key via diffie hellman key exchange
#### *async* action_map(data: dict)
Map new network data to internal network map
#### SEE ALSO
2024-07-29 03:47:27 +00:00
`Siph.network.Network`
2024-07-28 11:21:15 +00:00
: Layered graph etwork representation
#### *async* action_sendCatch(data: dict)
Get catch and return the data to a peer
#### *async* action_sendToPeer(data: dict)
Send data to a peer connected to the server
* **Parameters:**
**data** (*dict*) Data passed from the filter, this is a generic object so its similar on all actions here
#### SEE ALSO
2024-08-01 01:00:46 +00:00
`Sponge.Protocols`
2024-07-28 11:21:15 +00:00
: Protocol based packet filtering
`webui.serve.Server`
: Runs a light Microdot web server with http/s and websocket functionality
`webui.serve.Server.sendToPeer`
: Function to actually execute the action
#### cLog(priority: int, message: str)
Convenience function that logs to the ui and log files
* **Parameters:**
* **priority** (*int*) Priority of message to be passed to logging
* **message** (*str*) Message to log
* **Return type:**
None
2024-07-29 03:47:27 +00:00
#### *async* spongeListen()
2024-07-28 11:21:15 +00:00
Loop to watch for tasks to do
#### SEE ALSO
2024-08-01 01:00:46 +00:00
`Sponge.base.sieve`
2024-07-28 11:21:15 +00:00
: Packet filtering/parsing
### Notes
We use a common technique here that calls the function from our preloaded actions via dictionary entry