diff options
author | UnavailableDev <ggwildplay@gmail.com> | 2023-01-17 21:46:56 +0100 |
---|---|---|
committer | UnavailableDev <ggwildplay@gmail.com> | 2023-01-17 21:46:56 +0100 |
commit | 95101cb750b8f749509f757cd1cd8ebbad7c67ad (patch) | |
tree | c4a5d79353c3964dda97960df8f8fc87ad594338 | |
parent | 4c204bfc70dea53ccb6b7a7fd74d01a2c4b6b358 (diff) |
framework
-rw-r--r-- | docs/design.md | 65 |
1 files changed, 35 insertions, 30 deletions
diff --git a/docs/design.md b/docs/design.md index 17e09cc..eff342a 100644 --- a/docs/design.md +++ b/docs/design.md @@ -26,9 +26,43 @@ details are: # Framework +The following two are the possible frameworks for this project to use: +## segger: +For this there was very little to non research before starting this project. +## Zephyr: + +This can be used with either a makefile system and the correct libraries or with the highly integrated visualstudio code extension. Because of this integration making a custom makefile is too time intensive for this project and the visualstudio code extension works great already. + +Further more zephyr and nordic both keep supporting their software with frequent updates and there are plenty of examples made with this. + +Thus the desicion has been made to use this option. + + + +# Data transfer between GUI and mesh network + +## Asynchronous data handling + +Because the data will be received asynchronously, certain decisions will have to be made about how to deal with this. In this case the GUI or client sends out requests/tasks to the border router. The border node then responds after x time. In both cases this triggers a callback function on the receiving end, so that the data can be handled accordingly, see the image below. + +![img](img/fig-AsyncCommunication.svg) + +## Communication standards + +There are two options available, each has its own set of benefits listed in the table below. + +<figure> +| UART | Bluetooth | +| --------------------- | ---------- | +| Less interference | Wireless | +| Simpler | Complexer | +| Available on all pc's | (opposite) | +<figcaption>Benefits of UART vs Bluetooth</figcaption> +</figure> +Seeing that there are more pro's to using UART then Bluetooth, it makes the most sense to use UART. # Custom serial protocol @@ -112,33 +146,4 @@ For now, there are two semaphores created in the provisioner software. The first |Zephyr|3.1| |nRF SDK|2.1.2| <figcaption>Software and library functions</figcaption> -</figure> - - - - - - -# Data transfer between GUI and mesh network - -## Asynchronous data handling - -Because the data will be received asynchronously, certain decisions will have to be made about how to deal with this. In this case the GUI or client sends out requests/tasks to the border router. The border node then responds after x time. In both cases this triggers a callback function on the receiving end, so that the data can be handled accordingly, see the image below. - -![img](img/fig-AsyncCommunication.svg) - -## Communication standards - -There are two options available, each has its own set of benefits listed in the table below. - -<figure> -| UART | Bluetooth | -| --------------------- | ---------- | -| Less interference | Wireless | -| Simpler | Complexer | -| Available on all pc's | (opposite) | -<figcaption>Benefits of UART vs Bluetooth</figcaption> -</figure> -Seeing that there are more pro's to using UART then Bluetooth, it makes the most sense to use UART. - -## Custom protocol
\ No newline at end of file +</figure>
\ No newline at end of file |