Project logo

MeshNet model

MeshNet model is project, which models and simulates MeshNet protocol.


MeshNet model

MeshNet model is project, which models and simulates MeshNet protocol. It consists of two parts:

  • MeshProtocolSimulator is console application, which provides simulation of MeshNet protocol. It is controlled by commands and has no GUI.
  • SimulationGUI is GUI for designing topology of mesh network, which will be simulated by MeshProtocolSimulator. It can also display simulation results, but it is still in development.

MeshProtocolSimulator v1.0.0

MeshProtocolSimulator is console application programmed in C++ which can emulate virtual wireless environment for MeshNet protocol. The simulation can detect interference between nodes and interfered frame won't be received by nodes. Environmental noise or link quality cannot be simulated right now, but we want to implement it. The simulation can be controlled by commands or by scenario file. Simulation process can be recorded to log file, which can be later analyzed.

Main classes

  • Emulator class controlls whole simulation. This class allows interventions in the simulation or can invoke functions like: send, receive, connect, disconnect, ping, network scan, etc. Network topology is also specified in this class thanks to array of NodeConnections structures, which defines link between two nodes. Network topology can be default or can be specified in scenario file. Default topology looks like this:


    where numbers are MeshMAC addresses and node 1 is gateway. This class also controlls timing of the simulation for each node. Although each NodeSimulator instance has its own thread, only the code of one node can be processed at a time. This is because code for all nodes in virtual network has to be done simultaneously for proper timing, but CPUs has only limited count of cores, which can also process threads of another applications. We solved this by executing the code of only one node that is far behind in the simulation. Code execution is paused when a node sends or receives a frame or tries to determine the number of received frames by calling available() function or one cycle from infinity loop on a node was done.

  • NodeSimulator class handles simulation of one Node. It also describes the node behavior with structure NodeSettings. This class also handles frames sending and receiving. Those frames are sent as RawMessage. It also checks if interference happened. There are two types of interferences which may occur:
    • hidden terminal interference which may happen when two nodes (let's say A and C) simultaneously transmits data and node B hears transmission from A and C. Both messages will be discarded on node B, because in reality, they will be interfered. But when there is node D, which can hear only node A, it will receive this message, because it is not interfered.
    • half-duplex collision which may happen when node A transmits data, but also node B transmits data. Wireless communication on one channel is always half-duplex, so these nodes will not receive data from each other because they are busy transmitting.
  • RawMessage structure represents raw message, that was sent between two virtual radios. It has no header and data are not structured.
  • Simulation_RFI class is interface, which behaves as real radio, which is described by NodeSettings.

Simulation control and settings

Simulation contol can be dividen into 4 phases:

  1. Launching simulation happens when console application is launched. Simulation can be setup by arguments and switches:
    • -a or --autopause - If set, auto pause is enabled. Simulation will be auto paused after one second of inactivity. Simulation is also paused at the beginning of simulation.
    • -o or --logonly - Can be used only if log file path is specified. Simulation logs are not showed to screen but are written only to specified log file.
    • -r or --raw - Output showed on screen will be in raw form. This is recommended to use, when output is redirected to some application, which controls simulation.
    • -s - After this switch scenario file path must be specified.
    • -l - After this switch log file path must be specified.
    • -h or --help shows help.
    • -v or --version shows version.
  2. Setting up simulation is the first phase after launching the simulation, when "Setting up" text shows up in the console window. During setup, those commands can be called:
    • auto pause <enabled/disabled:enable> which enables or disables auto pause after one second of inactivity. For example: "auto pause enabled".
    • begin runs simulation, see third phase.
    • end exits simulation.
    • help shows help.
  3. Starting simulation - during this phase virtual network is created and scenario file is read. Scenario file can contain settings for simulation (for example: auto pause setting, simulation time limit, etc.) and settings for each node such as node MCU frequency, transmission bitrate, SSID, etc. Special case is auto pause setting, if auto pause was enabled or disabled before this phase, auto pause setting from scenario file will be ignored.
  4. During simulation it can be controlled by the following commands:
    • resume - Resumes simulation.
    • resume for <ulong:time> - Resumes simulation for specified simulation time in nanoseconds.
    • pause - Pauses simulation.
    • auto pause <enabled/disabled:enable> which enables or disables auto pause after one second of inactivity.
    • ping <uint:source> <uint:destination> <uint:timeout[1000, 127500]> <uint:load[0, 500]> - Pings specified node with "destination" MAC address from module with "source" MAC address.
    • send <uint:from> <uint:to> <message> - Invokes message send from node with "from" MAC address to module with MAC "to" address.
    • net scan <uint:node> <uint:timeout[500,10000]> - Invokes network scan on node with "node" MAC address with "timeout" in ms.
    • connect <uint:from> <uint:to> - Invokes connection of node with MAC address "from" to node with MAC address "to".
    • disconnect <uint:from>- Invokes node disconnection with MAC address "from".
    • disconnect request <uint:gateway> <uint:node> - Invokes disconnection of "node" by "gateway" node.
    • network drop <uint:gateway> <-f:forced drop> - Invokes network drop by "gateway" node.
    • print table <uint:node> <rt/idt/fidt/oidt/dhcpt/wf/of:table_type> - Prints out table or buffer of type "table_type" of node with MAC address "node". For example: print table 1 rt.
    • end - Turns off simulation and exits application. This must be called before closing simulation to correctly save log file.
    • help - Shows help.

How to view documentation

  1. Download and install doxygen to your device.
  2. When you use:
    • Windows - run makeDoc.bat file, it will create documentation to html directory and opens it. When you have already generated documentation directory (html), you can view it by opening index.html file in that directory.
    • Linux or Mac - run doxygen.exe in console in folder to generate documentation. Open file in html/index.html

Used libraries and codes

  • RapidJSON library for JSON parsing in C++
  • Date library for C++
  • Base64 small library for Base64 encoding and decoding in C++
  • ConsoleTextColor small library for coloring text in console for windows and linux in C++

License

Copyright 2022 Matej Fitoš

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Author

Created by Matej Fitoš

Copyright © 2022 Matej Fitoš

                             Apache License
                       Version 2.0, January 2004
                    http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

  1. Definitions.

    "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

    "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

    "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

    "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

    "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

    "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

    "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

    "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

    "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

    "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

  3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

  4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

    (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and

    (b) You must cause any modified files to carry prominent notices stating that You changed the files; and

    (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

    (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

    You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

  5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

  6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

  7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

  8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

  9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

    END OF TERMS AND CONDITIONS

    APPENDIX: How to apply the Apache License to your work.

    To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

    Copyright 2022 Matej Fitoš

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Contributors 2

Matej Fitoš 94.81%

Juraj Ďuďák 5.19%


Links

Languages

  • C++ 88.13%
  • C# 8.96%
  • C 1.18%
  • Objective-C++ 0.52%
  • CMake 0.5%

  • Application
    Last update

    2022-05-05 22:39:23

    Created at

    24.02.2021