piermesh/docs/readme.md

PierMesh documentation

Contents:

• run: PierMesh service runner
  • Node
    • Node.actions
    • Node.todo
    • Node.network
    • Node.catch
    • Node.cache
    • Node.nodeInfo
    • Node.onodeID
    • Node.oTransceiver
    • Node.proc
    • Node.mTasks
    • Node.action_addPSK()
    • Node.action_hop()
    • Node.action_initCryptography()
    • Node.action_map()
    • Node.action_routeCatch()
    • Node.action_routeHop()
    • Node.action_sendCatch()
    • Node.action_sendToPeer()
    • Node.action_syncIndex()
    • Node.fsInit()
    • Node.main()
    • Node.monitor()
    • Node.spongeListen()
• tlog
  • VHandler
    • VHandler.tolog
    • VHandler.emit()
    • VHandler.tolog
  • logUI()
  • runLogUI()
• Network: Network map representation
  • Network
    • Network.omap
    • Network.imap
    • Network.emaps
    • Network.lookup
    • Network.addLookup()
    • Network.addie()
    • Network.addin()
    • Network.addoe()
    • Network.addon()
    • Network.doLookup()
    • Network.export()
      • Network.path
    • Network.getRoute()
    • Network.mimport()
    • Network.render()
    • Network.syncaddLookup()
• hopper: Small internet interop utilities
  • downloadFile()
  • get()
  • post()
• Daisy based cache
  • Cache
    • Cache.create()
    • Cache.get()
    • Cache.refresh()
    • Cache.search()
• Daisy Catch cache
  • Catch
    • Catch.get()
    • Catch.sget()
• Credential
  • Credential
• CryptographyUtil
  • SteelPetal
    • SteelPetal.decrypt()
    • SteelPetal.encrypt()
    • SteelPetal.pad()
• Daisy
  • Daisy
    • Daisy.filepath
    • Daisy.msg
    • Daisy.get()
    • Daisy.json_to_msg()
    • Daisy.read()
    • Daisy.sublist()
    • Daisy.write()
• Index
  • Index
    • Index.addEntry()
    • Index.search()
• Ref
  • Ref
• Store: Daisy key value store
  • Store
    • Store.epehemeral
    • Store.createEmpty()
    • Store.getRecord()
    • Store.update()
• WhaleSong
  • Transport
    • Transport.loadedKeys
    • Transport.nodeNickname
    • Transport.cache
    • Transport.publicKey
    • Transport.privateKey
    • Transport.daisyCryptography
    • Transport.addPeerEphemeralKey()
    • Transport.addPublickey()
    • Transport.decrypt()
    • Transport.encrypt()
    • Transport.genOurEphemeralKey()
    • Transport.genStaticKey()
    • Transport.generateSessionKey()
    • Transport.getRecord()
    • Transport.initStore()
    • Transport.kdf()
    • Transport.sessionSetup()
• base: Primary filtering functionality
  • Filter
    • Filter.cache
    • Filter.onodeID
    • Filter.todo
    • Filter.cryptographyInfo
    • Filter.messages
    • Filter.submessages
    • Filter.completed
    • Filter.mCheck()
    • Filter.protoMap()
    • Filter.selfCheck()
    • Filter.sieve()
• Sponge.Protocols.Yellow
  • YCTX
  • Yellow
    • Yellow.yctx
    • Yellow.message
    • Yellow.submessages
    • Yellow.submessagesIDs
    • Yellow.finishedSubmessages
    • Yellow.dataOrder
    • Yellow.data
    • Yellow.nonce
    • Yellow.tag
    • Yellow.gotHead
    • Yellow.todo
    • Yellow.checkComplete()
    • Yellow.doAct()
    • Yellow.dump()
    • Yellow.id()
    • Yellow.pActions
    • Yellow.processPacket()
• Sponge.Protocols.bubble
  • Bubble
    • Bubble.pActions
• Sponge.Protocols.catch
  • Catch
    • Catch.pActions
• Sponge.Protocols.cryptography
  • CryptographyFilter
    • CryptographyFilter.pActions
• Sponge.Protocols.hopper
  • Hopper
    • Hopper.pActions
• Sponge.Protocols.map
  • Map
    • Map.pActions
    • Map.process()
• Header packet: Metadata packet
  • Header
    • Header.sender
    • Header.senderDisplayName
    • Header.recipient
    • Header.recipientNode
    • Header.subpacket
    • Header.wantFullResponse
    • Header.pAction
    • Header.dump()
    • Header.usePreset()
• Packet: Base packet
  • Packet
    • Packet.data
    • Packet.packetsID
    • Packet.packetNumber
    • Packet.packetCount
    • Packet.packetsClass
    • Packet.dump()
    • Packet.parsePayload()
• SinglePacket: Singular packet messages for very low data applications
  • SinglePacket
• SubMessage: Additional data for larger messages
  • SubMessage
• SubPacket: Packets for submessages
  • SubMessage
• bubble.Bubble
  • Bubble
• catch.IndexSync
  • IndexSync
• catch.Request
  • CatchRequest
• catch.Response
  • CatchResponse
• cryptography.Handshake
  • Handshake
• hopper.Request
  • HopperRequest
• hopper.Response
  • HopperResponse
• map.Announce
  • AnnounceMessage
• Transceiver: Layer 0 data transceiving
  • Transceiver
    • Transceiver.cLog
    • Transceiver.cryptographyInfo
    • Transceiver.filter
    • Transceiver.tcache
    • Transceiver.tcatch
    • Transceiver.notConnected
    • Transceiver.acks
    • Transceiver.onodeID
    • Transceiver.messages
    • Transceiver.addPackets()
    • Transceiver.announce()
    • Transceiver.awaitFullResponse()
    • Transceiver.awaitResponse()
    • Transceiver.initNodeDH()
    • Transceiver.onConnection()
    • Transceiver.onReceive()
    • Transceiver.progressCheck()
    • Transceiver.responseCheck()
    • Transceiver.send()
    • Transceiver.sendAnnounce()
    • Transceiver.sendMessage()
• serve: Web UI server
  • Server
    • Server.transceiver
    • Server.network
    • Server.nodeID
    • Server.peerIDs
    • Server.app
    • Server.catch
    • Server.getPSKs()
    • Server.sendToPeer()
• Context
  • Context
    • Context.ctx
• Services.Action
  • Action
    • Action.action
    • Action.data
    • Action.sender
    • Action.senderID
    • Action.sourceNode
    • Action.recipient
    • Action.recipientNode
    • Action.getAction()
    • Action.getData() $

System Overview

PierMesh has two main events loops to learn about: the TUI and the service.

TUI

🔗 Docs

🔗 Source

The TUI is provided via curses library. It's a relatively simple application that gives us a quick overview of system statistics in the way of memory and cpu usage as well as logs you can scroll with the directional keys

The Service

PierMesh runs a number of loops under the hood. These are primarily initialized in the main loop of run with a special logging loop outside of that.

Note that we make use of Meshtastic's Python API.

run

🔗 run.py docs

🔗 run.py source

run.main

In run.main we (in order)

1. Initialize the Node class to a global nodeOb.
2. Wait for x seconds determined by command line arguments (see the falin script in scripts)
3. Initialize our Transceiver class (and the corresponding hardware)
4. Initialize our Server class
5. Create an async task running the Node.spongeListen method which looks for updates from the filter system
6. Kick the loop on with await asyncio.sleep(1) (we do this to kick on all async loops so I will omit this step going forward)
7. Create an async task running the Transceiver.checkProgress method which checks for packet reception progress and resends packets if necessary (currently not in use)
8. Create an async task running Node.monitor which checks and reports system usage
9. Create an async task running the Transceiver.announce method which broadcasts a Packets.Message containing network mapping information
10. Last we start the Microdot server loop

..

Travelling out of the run.main thread to the primary main code we see the other thread running the TUI loop which has it's own system we just kick on by running .runLogUI

Packet lifecycle

Prior to this we've been talking relatively high level but if you've read this far you probably want more low level details. Let's talk about packets.

Packets.Packet

This is a base singular packet. At the very least a packet will contain: a packets ID which determines what set of packets (message) a singular packet belongs to if any, a packetNumber which determines which order the data will be put in, a packetCount which is, well a count of all the packets in a set of packets and in most cases data which is an lzma compressed msgpack encoded chunk of data to be fused together when the full set of packets is received.

Packets.HeaderPacket

This is the metadata packet for a set of packets (message) which handles the details necessary for routing and action triggering

Packets.Message

A set of packets instantiated primarily from lzma compressed msgpack encoded bytes

You keep saying msgpack what is that?

msgpack is what I landed on for bundling metadata and arbitrary bytes after initially using bson as msgpack is leaner, simpler and better adopted for cross platform data interchange

Transmitting

Once we have our msgpack encoded lzma compressed data we can send it with Transceiver.addPackets this method creates a Message and sends each Packet (dumped to binary data) over LoRa using Meshtastic's Python interface via the Transceiver.send method.

Receiving

On the other end when we receive a Packet we pass it directly into Sponge.base.sieve which checks: if it's msgpack encoded and if it's a packet sent by the same node. In both cases it skips the packet, otherwise we sieve!

Sieving

Primarily in this stage we are gathering packets and adding them to an object containing all of the packet info and data we've received for that Message.

Once a Message is completed we pass it on to the appropriate protocol from Sponge.Protocols. These will pass the Message wherever it needs to go from there which can be any number of places.

To avoid unnecessary manual documentation labor for future devs I will not list everything that could happen here but here are some examples:

• Updating a Catch
• Sending a message up to a peer on the node
• Sending a Diffie Hellman handshake

Fin

Well not really, there's more to learn but these are the basics. There's more in the docs above and you can always submit an issue or reach me at info@piermesh.net or on Tumblr at utopicwork.