From ab300a9a480ffa1ec88b6521b2a39b518b1b720f Mon Sep 17 00:00:00 2001 From: Benjamin Christau Date: Thu, 11 Aug 2022 16:43:19 +0200 Subject: [PATCH] Revert "Fix broken links in the last test" This reverts commit 10e3e7c283942c9f9516e8a669b4a17d614306c7. --- apps/documentation/README.md | 24 +++++++------------ .../blog/2020-01-13-lift-banana-motors.mdx | 2 +- .../blog/2021-08-13-release-v130.mdx | 8 +++---- .../blog/2021-09-13-release-v200.mdx | 6 ++--- .../blog/2021-10-13-profiles.mdx | 2 +- .../blog/2021-11-13-embedded-packages.mdx | 2 +- .../blog/2021-12-13-bootloader.mdx | 2 +- .../blog/2022-01-13-gate-discovering.mdx | 2 +- .../blog/2022-04-15-web-app-alpha-version.mdx | 6 ++--- .../2022-06-07-cyber-physical-systems.mdx | 2 +- .../message/advanced-message.mdx | 2 +- .../docs/luos-technology/message/command.mdx | 2 +- .../docs/luos-technology/node/luos-hal.mdx | 2 +- .../docs/luos-technology/node/topology.mdx | 8 +++---- apps/documentation/docs/tools/gate.mdx | 4 ++-- apps/documentation/docs/tools/index.mdx | 18 +++++++------- apps/documentation/docs/tools/inspector.mdx | 4 ++-- apps/documentation/docusaurus.config.js | 4 ++-- .../faq/001.detection-reconfig.mdx | 2 +- apps/documentation/faq/002.dfu.mdx | 2 +- .../faq/004.application-default-handler.mdx | 2 +- .../src/components/index/anatomy/anatomy.js | 6 ++--- .../index/integration/integration.js | 10 ++++---- .../src/components/index/powered/powered.js | 6 ++--- .../tutorials/arduino/arduino.mdx | 2 +- .../documentation/tutorials/arduino/intro.mdx | 2 +- .../tutorials/bike-alarm/basic-alarm.mdx | 6 ++--- .../tutorials/bootloader/bootloader.mdx | 8 +++---- .../tutorials/bootloader/intro.mdx | 2 +- apps/documentation/tutorials/esp/connect.mdx | 2 +- apps/documentation/tutorials/esp/esp.mdx | 2 +- .../tutorials/freertos/intro.mdx | 2 +- .../tutorials/get-started/get-started1.mdx | 2 +- .../tutorials/get-started/get-started2.mdx | 2 +- .../tutorials/get-started/get-started3.mdx | 6 ++--- .../tutorials/get-started/get-started4.mdx | 2 +- .../tutorials/morse/add-service.mdx | 2 +- apps/documentation/tutorials/pio/include.mdx | 2 +- .../tutorials/resilient-alias/intro.mdx | 2 +- .../your-first-detection/embedded-app.mdx | 2 +- .../your-first-detection/routing-table.mdx | 4 ++-- .../your-first-detection/topology.mdx | 4 ++-- .../your-first-detection.mdx | 2 +- .../your-first-message/send-message.mdx | 2 +- .../your-first-message/your-first-message.mdx | 2 +- .../your-first-service/create-a-package.mdx | 2 +- .../your-first-service/luos-service.mdx | 2 +- .../message/advanced-message.mdx | 2 +- .../luos-technology/message/command.mdx | 2 +- .../luos-technology/node/luos-hal.mdx | 2 +- .../luos-technology/node/topology.mdx | 8 +++---- .../version-2.5.0/tools/gate.mdx | 4 ++-- .../version-2.5.0/tools/index.mdx | 18 +++++++------- .../version-2.5.0/tools/inspector.mdx | 4 ++-- 54 files changed, 113 insertions(+), 119 deletions(-) diff --git a/apps/documentation/README.md b/apps/documentation/README.md index 1b4248c0..efc117c0 100644 --- a/apps/documentation/README.md +++ b/apps/documentation/README.md @@ -8,31 +8,25 @@ [![](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Unleash%20electronic%20devices%20as%20microservices%20thanks%20to%20Luos&https://luos.io&via=Luos_io&hashtags=embeddedsystems,electronics,microservices,api) # Documentation - ## The most for the developer​ - Luos provides a simple way to think your hardware products as a group of independant features. You can easily manage and share your hardware products' features with your team, external developers, or with the community. Luos is an open-source lightweight library that can be used on any MCU, leading to free and fast multi-electronic-boards products development. Choosing Luos to design a product will help you to develop, debug, validate, monitor, and manage it from the cloud. - -- → Go to the [Luos Documentation](https://docs.luos.io) +* → Go to the [Luos Documentation](https://docs.luos.io) ## The most for the community​ - Most of the embedded developments are made from scratch. By using Luos, you will be able to capitalize on the development you, your company, or the Luos community already did. The re-usability of features encapsulated in Luos services will fasten the time your products reach the market and reassure the robustness and the universality of your applications. -- → Join the [Luos Discord Community](https://discord.gg/luos) -- → Join the [Luos Reddit Community](http://bit.ly/JoinLuosReddit) +* → Join the [Luos Discord Community](https://discord.gg/luos) +* → Join the [Luos Reddit Community](http://bit.ly/JoinLuosReddit) ## Good practices with Luos​ - Luos proposes organized and effective development practices, guaranteeing development flexibility and evolutivity of your hardware product, from the idea to the maintenance of the industrialized product fleet. ## Let's do this​ - This section details the features of Luos technology as an embedded development platform, following these subjects: -- Let's test through the [Luos get started](https://docs.luos.io/get-started/get-started/), to build, flash, run, and control your very first Luos code. -- The [Basics of Luos](https://docs.luos.io/docs/test/luos-technology/basics/basics), explaining the general concepts and the project organization. -- Definition of [Nodes](https://docs.luos.io/docs/test/luos-technology/node/node), and the relation between Luos and the physical world. -- Definition of [Packages](https://docs.luos.io/docs/test/luos-technology/package/package), and how to make a portable and reusable development. -- Definition of [Services](https://docs.luos.io/docs/test/luos-technology/services/services), how to create and declare features in your product. -- Definition of [Messages](https://docs.luos.io/docs/test/luos-technology/message/message), when, why, and how to handle them, explaining the more advanced features of Luos. +* Let's test through the [Luos get started](https://docs.luos.io/get-started/get-started/), to build, flash, run, and control your very first Luos code. +* The [Basics of Luos](https://docs.luos.io/docs/luos-technology/basics/basics), explaining the general concepts and the project organization. +* Definition of [Nodes](https://docs.luos.io/docs/luos-technology/node/node), and the relation between Luos and the physical world. +* Definition of [Packages](https://docs.luos.io/docs/luos-technology/package/package), and how to make a portable and reusable development. +* Definition of [Services](https://docs.luos.io/docs/luos-technology/services/services), how to create and declare features in your product. +* Definition of [Messages](https://docs.luos.io/docs/luos-technology/message/message), when, why, and how to handle them, explaining the more advanced features of Luos. diff --git a/apps/documentation/blog/2020-01-13-lift-banana-motors.mdx b/apps/documentation/blog/2020-01-13-lift-banana-motors.mdx index ba064c1f..c25e4a84 100644 --- a/apps/documentation/blog/2020-01-13-lift-banana-motors.mdx +++ b/apps/documentation/blog/2020-01-13-lift-banana-motors.mdx @@ -223,7 +223,7 @@ The choice is obvious. Additionally, famous and cheap tools (like electronic boards Arduino, Raspberry Pi, _etc._) allow people who are not professional to gain accessible robotics by controlling many kinds of motors, including servo motors. -[Our tutorials](/docs/test/luos-technology/services/profile) help you discover how to control your servo motor with Luos. +[Our tutorials](/docs/luos-technology/services/profile) help you discover how to control your servo motor with Luos. By the way, we developed a little video showing a few command lines to make a servo motor work: diff --git a/apps/documentation/blog/2021-08-13-release-v130.mdx b/apps/documentation/blog/2021-08-13-release-v130.mdx index 7194c6dc..f2dbadd0 100644 --- a/apps/documentation/blog/2021-08-13-release-v130.mdx +++ b/apps/documentation/blog/2021-08-13-release-v130.mdx @@ -49,7 +49,7 @@ This new type of driver can be used for different purposes, and the gate App nee As a gate user, you will only have to adapt this Pipe driver to your needs. The gate will deal with it. -More details about this can be found in the [Gate](/docs/test/tools/gate) section of our documentation. +More details about this can be found in the [Gate](/docs/tools/gate) section of our documentation.

🆕 Feature: Add access management to container

@@ -81,11 +81,11 @@ More details in our documentation. When it comes to developing the behavior of your machine, you will have to access some drivers. -With Luos, all the resources of your system are resumed into a [routing_table structure](/docs/test/luos-technology/services/routing-table). This structure allows you to find the resources you need to make your application work. We are constantly updating and optimizing the functions allowing you to easily find the resources you need. +With Luos, all the resources of your system are resumed into a [routing_table structure](/docs/luos-technology/services/routing-table). This structure allows you to find the resources you need to make your application work. We are constantly updating and optimizing the functions allowing you to easily find the resources you need. In this revision 1.3.0 of Luos, we added index research, giving you the most optimized way of getting resource information. -More details about this are on the [routing_table](/docs/test/luos-technology/services/routing-table) section of our documentation. +More details about this are on the [routing_table](/docs/luos-technology/services/routing-table) section of our documentation.

🆕 Feature: Localhost verbose management

@@ -97,7 +97,7 @@ This is a huge deal to improve your Luos system performances, and you should tak If you need to get all the data into the network, for example for debugging purposes, you can use the **VERBOSE_LOCALHOST** build flag that disables this feature! -More details about this subject in the [messages handling](/docs/test/luos-technology/message/handling-message) section of our documentation. +More details about this subject in the [messages handling](/docs/luos-technology/message/handling-message) section of our documentation.

🛠️ Fix: Streaming better management for DMA transmission

diff --git a/apps/documentation/blog/2021-09-13-release-v200.mdx b/apps/documentation/blog/2021-09-13-release-v200.mdx index af408cc7..a90db2d5 100644 --- a/apps/documentation/blog/2021-09-13-release-v200.mdx +++ b/apps/documentation/blog/2021-09-13-release-v200.mdx @@ -33,15 +33,15 @@ This is the seventh release of Luos. We described below the various features and

🆕 Feature: Profiles to simplify user API

-Profiles are predefined structures representing a service type. Since Luos 2.0.0 you can comply services to a specific profile allowing anyone to know how your feature work. For example, any kind of motor (stepper, brushless, Dynamixel, ...) can use the servo-motor profile, then you can control any of them exactly the same way. Profiles also simplify your motor driver development. Instead of dealing with messages, profiles give you input and output variables to interact with anything else (other services, cloud app, ...). You can easily create your own profiles and share them with the community or with your team as a feature API definition. [More information on our documentation](/docs/test/luos-technology/services/profile) +Profiles are predefined structures representing a service type. Since Luos 2.0.0 you can comply services to a specific profile allowing anyone to know how your feature work. For example, any kind of motor (stepper, brushless, Dynamixel, ...) can use the servo-motor profile, then you can control any of them exactly the same way. Profiles also simplify your motor driver development. Instead of dealing with messages, profiles give you input and output variables to interact with anything else (other services, cloud app, ...). You can easily create your own profiles and share them with the community or with your team as a feature API definition. [More information on our documentation](/docs/luos-technology/services/profile)

🆕 Feature: Packages to simplify portability

-Packages allow you to store your embedded code features on sharable folders. So you can move those easily from one project to another and share it with the community. We have big plans for this feature so keep in touch... [more information about packages](/docs/test/luos-technology/package) +Packages allow you to store your embedded code features on sharable folders. So you can move those easily from one project to another and share it with the community. We have big plans for this feature so keep in touch... [more information about packages](/docs/luos-technology/package)

🆕 Feature: Bootloader

-This feature is the big new one everyone has asked us for years. Now, you can compile luos in bootloader mode. By compiling it this way you can flash it to your board then use the Luos network through a gate to update your board firmware. This allows you to update any board anywhere on your device without having physical access to it. [More information about bootloader](/docs/test/tools/boot) +This feature is the big new one everyone has asked us for years. Now, you can compile luos in bootloader mode. By compiling it this way you can flash it to your board then use the Luos network through a gate to update your board firmware. This allows you to update any board anywhere on your device without having physical access to it. [More information about bootloader](/docs/tools/boot) 🛠️ Fix: ATSAMD21 register typography diff --git a/apps/documentation/blog/2021-10-13-profiles.mdx b/apps/documentation/blog/2021-10-13-profiles.mdx index 96cc5943..6b29fbf8 100644 --- a/apps/documentation/blog/2021-10-13-profiles.mdx +++ b/apps/documentation/blog/2021-10-13-profiles.mdx @@ -25,6 +25,6 @@ For example, any motor (stepper, brushless, Dynamixel, ...) can use the servo-mo You can easily create your own profiles and share them with the community or your team as a feature API definition. Luos is **open-source**. -[Check the Luos documentation dedicated to profiles](/docs/test/luos-technology/services/profile) +[Check the Luos documentation dedicated to profiles](/docs/luos-technology/services/profile) [Get Started with Luos](/tutorials/get-started) diff --git a/apps/documentation/blog/2021-11-13-embedded-packages.mdx b/apps/documentation/blog/2021-11-13-embedded-packages.mdx index 41ef5de1..475e28f5 100644 --- a/apps/documentation/blog/2021-11-13-embedded-packages.mdx +++ b/apps/documentation/blog/2021-11-13-embedded-packages.mdx @@ -21,6 +21,6 @@ date: 2021-11-13T10:00 Packages allow you to store your embedded code features on sharable folders. So you can move those easily from one project to another and share them with the community. -We have big plans for this feature so keep in touch... [more information about packages](/docs/test/luos-technology/package) +We have big plans for this feature so keep in touch... [more information about packages](/docs/luos-technology/package) [Get Started with Luos](/tutorials/get-started) diff --git a/apps/documentation/blog/2021-12-13-bootloader.mdx b/apps/documentation/blog/2021-12-13-bootloader.mdx index 8dd24eb1..7dbc91e7 100644 --- a/apps/documentation/blog/2021-12-13-bootloader.mdx +++ b/apps/documentation/blog/2021-12-13-bootloader.mdx @@ -23,6 +23,6 @@ This feature is the big new one everyone has asked us for years. Now, you can co This allows you to update any board/firmware anywhere on your device without having physical access to it. -[More information about bootloader](/docs/test/tools/boot) +[More information about bootloader](/docs/tools/boot) [Get Started with Luos](/tutorials/get-started) diff --git a/apps/documentation/blog/2022-01-13-gate-discovering.mdx b/apps/documentation/blog/2022-01-13-gate-discovering.mdx index 7c730cf2..41dacf0a 100644 --- a/apps/documentation/blog/2022-01-13-gate-discovering.mdx +++ b/apps/documentation/blog/2022-01-13-gate-discovering.mdx @@ -21,6 +21,6 @@ New feature: "Gate discovering" Some of you struggle to find a device gate over USB or IP. We add a feature to gate that allows you to list all the gates available on your embedded system, directly from the opensource Luos Python library Pyluos. -→ [Discover our documentation](/docs/test/tools/gate) +→ [Discover our documentation](/docs/tools/gate) [Get Started with Luos](/tutorials/get-started) diff --git a/apps/documentation/blog/2022-04-15-web-app-alpha-version.mdx b/apps/documentation/blog/2022-04-15-web-app-alpha-version.mdx index 790930d2..c85876ec 100644 --- a/apps/documentation/blog/2022-04-15-web-app-alpha-version.mdx +++ b/apps/documentation/blog/2022-04-15-web-app-alpha-version.mdx @@ -35,7 +35,7 @@ With our first try to connect embedded systems with a Javascript app, we based o This normative-like document is near the _Web Bluetooth API_ and _Web USB API_, among other things. This promises us great compatibility if it works fine! -On the other side, we developed an application service called [Gate](/docs/test/tools/gate), which was intended to convert the Luos “generic software representation” into a JSON format. +On the other side, we developed an application service called [Gate](/docs/tools/gate), which was intended to convert the Luos “generic software representation” into a JSON format. The main advantages of the Gate were: @@ -51,7 +51,7 @@ But it came with drawbacks. Here are some of them: In the second iteration of our connectivity between a Javascript app and an embedded system, we worked on the way to gather all the messages emitted into a Luos network and then transmit them to our app. -To do that, we created a tool called [Sniffer](/docs/test/tools/monitoring#sniffer). The Sniffer tool came with a new communication protocol closer to the embedded one but also with drawbacks, and one of them was the design itself; a Sniffer can’t act on the embedded system! +To do that, we created a tool called [Sniffer](/docs/tools/monitoring#sniffer). The Sniffer tool came with a new communication protocol closer to the embedded one but also with drawbacks, and one of them was the design itself; a Sniffer can’t act on the embedded system!

The solution 📐

@@ -89,7 +89,7 @@ As you can see in figure 1, the data is encapsulated in a “Luos Frame” descr Now that we have set up this new way to communicate with the embedded world, the next step will be to give our users all the features implemented all over the years in Luos engine from a web perspective. -The first feature we decided to implement is the network topology. This feature is a graphical representation of the Luos [routing table](/docs/test/luos-technology/services/routing-table). +The first feature we decided to implement is the network topology. This feature is a graphical representation of the Luos [routing table](/docs/luos-technology/services/routing-table). We first get the list of the nodes and services in our network. Then we query each service of each node to get their properties like their type (Motor, Led, Gate, ...), their firmware revision, and their memory statistics. diff --git a/apps/documentation/blog/2022-06-07-cyber-physical-systems.mdx b/apps/documentation/blog/2022-06-07-cyber-physical-systems.mdx index c32109ad..3cb09525 100644 --- a/apps/documentation/blog/2022-06-07-cyber-physical-systems.mdx +++ b/apps/documentation/blog/2022-06-07-cyber-physical-systems.mdx @@ -61,7 +61,7 @@ With smart pyramidal modeling (or rather rocket-ideal here), we can obtain a rep One example of a CPS is Tesla Inc.'s autonomous car, the Tesla Model S. The Tesla Model S is a car that uses sensors and computers to autonomously drive itself. They are integrated with the internet and can be controlled remotely. -Another example is a power grid. The physical system is the grid itself, and the cyber one is the computer that monitors and controls the grid. The two devices are connected through a [network](/docs/test/luos-technology/node/topology), which in this case is the wired or wireless connection between the grid and the computer. +Another example is a power grid. The physical system is the grid itself, and the cyber one is the computer that monitors and controls the grid. The two devices are connected through a [network](/docs/luos-technology/node/topology), which in this case is the wired or wireless connection between the grid and the computer. When you're using software, CPS is all around you. Every time you use a GPS in your car or your smartphone, you interact with cyber-physical systems. diff --git a/apps/documentation/docs/luos-technology/message/advanced-message.mdx b/apps/documentation/docs/luos-technology/message/advanced-message.mdx index bc8d4f7d..b2169806 100644 --- a/apps/documentation/docs/luos-technology/message/advanced-message.mdx +++ b/apps/documentation/docs/luos-technology/message/advanced-message.mdx @@ -117,7 +117,7 @@ You can play, pause, stop or record a stream flux with the standard **CONTROL** ## How to use it -**A streaming channel is always created by the strict real-time service.** The other service (the non-real-time one) will just send or receive its data chunks using [large data messages](/docs/test/luos-technology/message/advanced-message#large-data). +**A streaming channel is always created by the strict real-time service.** The other service (the non-real-time one) will just send or receive its data chunks using [large data messages](/docs/luos-technology/message/advanced-message#large-data). ### Streaming channel creation diff --git a/apps/documentation/docs/luos-technology/message/command.mdx b/apps/documentation/docs/luos-technology/message/command.mdx index 7bcfa9b7..79eeafaa 100644 --- a/apps/documentation/docs/luos-technology/message/command.mdx +++ b/apps/documentation/docs/luos-technology/message/command.mdx @@ -10,7 +10,7 @@ import IconExternalLink from '@theme/Icon/ExternalLink'; Each message includes a command value that defines the content's type of the message's data. -Another feature included in Luos engine is the [Object Dictionary (OD)](/docs/test/luos-technology/message/object-dictionary), which aims to maintain interoperability of data format and command's type between services. +Another feature included in Luos engine is the [Object Dictionary (OD)](/docs/luos-technology/message/object-dictionary), which aims to maintain interoperability of data format and command's type between services. ## Commands diff --git a/apps/documentation/docs/luos-technology/node/luos-hal.mdx b/apps/documentation/docs/luos-technology/node/luos-hal.mdx index 5ce0f3b0..71e27dff 100644 --- a/apps/documentation/docs/luos-technology/node/luos-hal.mdx +++ b/apps/documentation/docs/luos-technology/node/luos-hal.mdx @@ -7,7 +7,7 @@ custom_edit_url: null Luos engine can work on a single node using localhost communication or it can create a network for communication between services located on different nodes. This communication should be defined and hardware-configured to fit with the chosen MCU. The files _luos_hal.c_ and _luos_hal.h_ define all the functions needed by Luos engine. Then, there is a HAL depending on the network layer you use to send messages through the physical bus. -The file _luos_hal_config.h_ contains a default configuration for an MCU family and can be redefined in a configuration file to fit your design. The configuration of Luos engine HAL is described [here](/docs/test/hardware-consideration/mcu). +The file _luos_hal_config.h_ contains a default configuration for an MCU family and can be redefined in a configuration file to fit your design. The configuration of Luos engine HAL is described [here](/docs/hardware-consideration/mcu). ## Luos engine's HAL diff --git a/apps/documentation/docs/luos-technology/node/topology.mdx b/apps/documentation/docs/luos-technology/node/topology.mdx index 744768a4..11007447 100644 --- a/apps/documentation/docs/luos-technology/node/topology.mdx +++ b/apps/documentation/docs/luos-technology/node/topology.mdx @@ -13,14 +13,14 @@ The nodes can access the position of every other node in the network at any time This routing table allows any service to find, locate, and use any other service on the entire network. -## [Routing Table](/docs/test/luos-technology/services/routing-table) +## [Routing Table](/docs/luos-technology/services/routing-table) -The [Routing Table](/docs/test/luos-technology/services/routing-table) is a feature of Luos allowing every node to own a "map" (or topology) of the entire network of your device. This map allows nodes to know their physical position and different functionalities, as well as to easily search and interact with the other nodes. +The [Routing Table](/docs/luos-technology/services/routing-table) is a feature of Luos allowing every node to own a "map" (or topology) of the entire network of your device. This map allows nodes to know their physical position and different functionalities, as well as to easily search and interact with the other nodes. -The [Routing Table](/docs/test/luos-technology/services/routing-table) is designed and shared among all the nodes after a process that is called [detection](/docs/test/luos-technology/services/routing-table). +The [Routing Table](/docs/luos-technology/services/routing-table) is designed and shared among all the nodes after a process that is called [detection](/docs/luos-technology/services/routing-table). :::info -More details about routing table on the [dedicated page](/docs/test/luos-technology/services/routing-table). +More details about routing table on the [dedicated page](/docs/luos-technology/services/routing-table). ::: ## PTP Network diff --git a/apps/documentation/docs/tools/gate.mdx b/apps/documentation/docs/tools/gate.mdx index d353fbd7..f5e4a12f 100644 --- a/apps/documentation/docs/tools/gate.mdx +++ b/apps/documentation/docs/tools/gate.mdx @@ -11,7 +11,7 @@ import Image from '@site/src/components/Image.js'; The gate is a major tool of the Luos ecosystem. It is allowing you to translate any Luos architecture into a more convenient format for standard software ([JSON] most of the time) and to stream and receive this formatted information into any kind of communication way such as serial interface, WiFi, Bluetooth, Lora, ... -You can use it to take control of any embedded service with [any languages](/docs/test/api) on any machine. For example, we use it in [Pyluos](/docs/test/tools/pyluos) or [ROS](/docs/test/tools/ros). +You can use it to take control of any embedded service with [any languages](/docs/api) on any machine. For example, we use it in [Pyluos](/docs/tools/pyluos) or [ROS](/docs/tools/ros). The gate is a simple embedded [app service](../luos-technology/services/service-api#apps-guidelines), so it can work on any MCU running Luos without any modification. @@ -77,7 +77,7 @@ When the gate and the pipe are on separate nodes, formated messages transit into ## The gate configurations -The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/test/luos-technology/basics/orga#configuration). +The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/luos-technology/basics/orga#configuration). You could need to change it if you have apps on your Luos embedded system. diff --git a/apps/documentation/docs/tools/index.mdx b/apps/documentation/docs/tools/index.mdx index e581fb79..6c2c9bf6 100644 --- a/apps/documentation/docs/tools/index.mdx +++ b/apps/documentation/docs/tools/index.mdx @@ -7,13 +7,13 @@ description: Luos provides many tools to interface, control, or monitor products Luos provides many tools to interface, control, or monitor products made with Luos engine. -| Services | Description | -| :---------------------------: | :---------------------------------------------------------------------------------------------------: | -| [Gate](/docs/test/tools/gate) | A translation Luos app service allowing you to easily connect your computer to your hardware product. | -| Inspector | A Luos service application allowing a computer to inspect a product. | +| Services | Description | +| :----------------------------------: | :-------------------------------------------------------------------------------------: | +| [Gate](/docs/tools/gate) | A translation Luos app service allowing you to easily connect your computer to your hardware product. | +| Inspector | A Luos service application allowing a computer to inspect a product. | -| Tools | Description | -| :---------------------------------------: | :----------------------------------------------------: | -| [Pyluos](/docs/test/tools/pyluos) | Python library using JSON API to communicate with gate | -| [BootLoder](/docs/test/tools/boot) | Update node through Luos Network | -| [Monitoring](/docs/test/tools/monitoring) | API that allows you to monitor a Luos network | +| Tools | Description | +| :----------------------------------: | :-------------------------------------------------------------------------------------: | +| [Pyluos](/docs/tools/pyluos) | Python library using JSON API to communicate with gate | +| [BootLoder](/docs/tools/boot) | Update node through Luos Network | +| [Monitoring](/docs/tools/monitoring) | API that allows you to monitor a Luos network | diff --git a/apps/documentation/docs/tools/inspector.mdx b/apps/documentation/docs/tools/inspector.mdx index a838345a..7e420bd3 100644 --- a/apps/documentation/docs/tools/inspector.mdx +++ b/apps/documentation/docs/tools/inspector.mdx @@ -53,7 +53,7 @@ int main(void) ## The inspector configurations -The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/test/luos-technology/basics/orga#configuration). +The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/luos-technology/basics/orga#configuration). You could need to change it if you have apps on you Luos embedded system. @@ -65,7 +65,7 @@ If you have an app service on your device managing detection, you should define ## Inspector vs. gate -As for the gate, the inspector needs a pipe to transfer information outside the Luos network. The pipe and inspector can be hosted into the same node or on different nodes in the network. It is recommended to have an inspector and a pipe on the same node to avoid overloading the Luos network with messages that can be handled locally on the node (see the [gate page](/docs/test/tools/gate) for more information). +As for the gate, the inspector needs a pipe to transfer information outside the Luos network. The pipe and inspector can be hosted into the same node or on different nodes in the network. It is recommended to have an inspector and a pipe on the same node to avoid overloading the Luos network with messages that can be handled locally on the node (see the [gate page](/docs/tools/gate) for more information). The inspector can be used with the gate in a network, the gate taking control of the sensors and the inspector displaying all the information, for example. diff --git a/apps/documentation/docusaurus.config.js b/apps/documentation/docusaurus.config.js index 661a00b2..d63e2e9e 100644 --- a/apps/documentation/docusaurus.config.js +++ b/apps/documentation/docusaurus.config.js @@ -115,7 +115,7 @@ module.exports = { label: 'Tutorials', }, { - to: '/docs/test/luos-technology', + to: '/docs/luos-technology', label: 'Documentation', }, { @@ -164,7 +164,7 @@ module.exports = { items: [ { label: 'Documentation', - to: '/docs/test/luos-technology', + to: '/docs/luos-technology', }, { label: 'Contact us', diff --git a/apps/documentation/faq/001.detection-reconfig.mdx b/apps/documentation/faq/001.detection-reconfig.mdx index 45f4b04c..e8c10123 100644 --- a/apps/documentation/faq/001.detection-reconfig.mdx +++ b/apps/documentation/faq/001.detection-reconfig.mdx @@ -124,4 +124,4 @@ Here is how to reconfigure after a detection: > **Associated documentation page(s):** > -> - [Gate](/docs/test/tools/gate) +> - [Gate](/docs/tools/gate) diff --git a/apps/documentation/faq/002.dfu.mdx b/apps/documentation/faq/002.dfu.mdx index dd09ae05..92359e4e 100644 --- a/apps/documentation/faq/002.dfu.mdx +++ b/apps/documentation/faq/002.dfu.mdx @@ -81,4 +81,4 @@ brew install libusb > **Associated documentation page(s):** > -> - [Gate](/docs/test/tools/gate) +> - [Gate](/docs/tools/gate) diff --git a/apps/documentation/faq/004.application-default-handler.mdx b/apps/documentation/faq/004.application-default-handler.mdx index fab181dd..b40cd06d 100644 --- a/apps/documentation/faq/004.application-default-handler.mdx +++ b/apps/documentation/faq/004.application-default-handler.mdx @@ -47,4 +47,4 @@ void EXTI4_15_IRQHandler(void) > **Associated documentation page(s):** > -> - [Hardware consideration](/docs/test/hardware-consideration) +> - [Hardware consideration](/docs/hardware-consideration) diff --git a/apps/documentation/src/components/index/anatomy/anatomy.js b/apps/documentation/src/components/index/anatomy/anatomy.js index cbd8807b..bd69eb87 100644 --- a/apps/documentation/src/components/index/anatomy/anatomy.js +++ b/apps/documentation/src/components/index/anatomy/anatomy.js @@ -57,7 +57,7 @@ const Anatomy = (props) => { @@ -132,7 +132,7 @@ const Anatomy = (props) => { @@ -148,7 +148,7 @@ const Anatomy = (props) => { diff --git a/apps/documentation/src/components/index/integration/integration.js b/apps/documentation/src/components/index/integration/integration.js index 4bd100e9..91cc4235 100644 --- a/apps/documentation/src/components/index/integration/integration.js +++ b/apps/documentation/src/components/index/integration/integration.js @@ -58,17 +58,17 @@ const Integration = (props) => { raspberry: '', arduino: '/tutorials/arduino/intro', pio: '/tutorials/get-started/get-started1#2-set-up-your-development-environment', - eclipse: '/docs/test/luos-technology/basics/orga#luos-engines-levels', - vscodeico: '/docs/test/luos-technology/basics/orga#luos-engines-levels', - ros: '/docs/test/tools/ros', - freertos: '/docs/test/tools/ros', + eclipse: '/docs/luos-technology/basics/orga#luos-engines-levels', + vscodeico: '/docs/luos-technology/basics/orga#luos-engines-levels', + ros: '/docs/tools/ros', + freertos: '/docs/tools/ros', microros: '', simplefoc: '', zapier: '', ifttt: '', freedom: '', c: '', - python: '/docs/test/tools/pyluos#required-installing-python-and-pip', + python: '/docs/tools/pyluos#required-installing-python-and-pip', js: '', ts: '', }; diff --git a/apps/documentation/src/components/index/powered/powered.js b/apps/documentation/src/components/index/powered/powered.js index f2a2e5e4..e63231a3 100644 --- a/apps/documentation/src/components/index/powered/powered.js +++ b/apps/documentation/src/components/index/powered/powered.js @@ -61,7 +61,7 @@ const Powered = (props) => { @@ -107,7 +107,7 @@ const Powered = (props) => { @@ -125,7 +125,7 @@ const Powered = (props) => { diff --git a/apps/documentation/tutorials/arduino/arduino.mdx b/apps/documentation/tutorials/arduino/arduino.mdx index 9d120967..09758f21 100644 --- a/apps/documentation/tutorials/arduino/arduino.mdx +++ b/apps/documentation/tutorials/arduino/arduino.mdx @@ -21,7 +21,7 @@ import IconExternalLink from '@theme/Icon/ExternalLink'; Arduino MKR Wifi, Arduino MKR FOX, Arduino MKR WAN, Arduino MKR GSM, Arduino NB, etc.).

-Creating a Luos network with an Arduino board is very easy. See the [hardware topics](/docs/test/hardware-consideration) page for more information. +Creating a Luos network with an Arduino board is very easy. See the [hardware topics](/docs/hardware-consideration) page for more information. ## 2. Let's started with Arduino IDE diff --git a/apps/documentation/tutorials/arduino/intro.mdx b/apps/documentation/tutorials/arduino/intro.mdx index 1780237c..1b3486c3 100644 --- a/apps/documentation/tutorials/arduino/intro.mdx +++ b/apps/documentation/tutorials/arduino/intro.mdx @@ -26,7 +26,7 @@ import Introduction from '@site/src/components/school/article/intro.js'; }, { label: 'Luos Basics', - link: useBaseUrl('/docs/test/luos-technology/basics'), + link: useBaseUrl('/docs/luos-technology/basics'), }, ]} shortList="true" diff --git a/apps/documentation/tutorials/bike-alarm/basic-alarm.mdx b/apps/documentation/tutorials/bike-alarm/basic-alarm.mdx index 2d21f33a..0caf549c 100644 --- a/apps/documentation/tutorials/bike-alarm/basic-alarm.mdx +++ b/apps/documentation/tutorials/bike-alarm/basic-alarm.mdx @@ -59,7 +59,7 @@ void AlarmController_Loop(void); ``` :::info -For more details about Luos code organization, please read the [Luos project organization page](/docs/test/luos-technology/basics/orga). +For more details about Luos code organization, please read the [Luos project organization page](/docs/luos-technology/basics/orga). ::: Now we have to fill both functions in the C file. @@ -82,7 +82,7 @@ void AlarmController_Init(void) As you can see, our app default alias will be `"alarm_control"`, and we created a custom service type. :::info -For more information about service creation, read the [Create Luos service page](/docs/test/luos-technology/services/service-api). +For more information about service creation, read the [Create Luos service page](/docs/luos-technology/services/service-api). ::: To declare to others this custom service type, we need to add an enum in the C file: @@ -120,7 +120,7 @@ void AlarmController_MsgHandler(service_t *service, msg_t *msg) Now we have to be able to get data from the IMU. To do that, our app will need a routing table. Routing tables are auto-generated and shared to all services in the network during detection. :::info -For more information, read the [routing table page](/docs/test/luos-technology/services/routing-table). +For more information, read the [routing table page](/docs/luos-technology/services/routing-table). ::: Because this app is stand-alone, it has to run a detection to create the routing table and configure the IMU to send gyro data each 10ms. diff --git a/apps/documentation/tutorials/bootloader/bootloader.mdx b/apps/documentation/tutorials/bootloader/bootloader.mdx index 837695a1..4bcd322f 100644 --- a/apps/documentation/tutorials/bootloader/bootloader.mdx +++ b/apps/documentation/tutorials/bootloader/bootloader.mdx @@ -9,7 +9,7 @@ import Image from '@site/src/components/Image.js'; ## 1. Acquire and set up your equipment -To flash one or multiple boards using the Luos engine's bootloader, you need a master board that will manage the link between your computer and the Luos network. So the minimal setup needed to use the bootloader is composed of two boards supported by Luos engine connected together with a Luos network. We will use one of these nodes as a "master" with a [gate](/docs/test/tools/gate) and the other will be able to be updated through the Luos network by hosting a bootloader. +To flash one or multiple boards using the Luos engine's bootloader, you need a master board that will manage the link between your computer and the Luos network. So the minimal setup needed to use the bootloader is composed of two boards supported by Luos engine connected together with a Luos network. We will use one of these nodes as a "master" with a [gate](/docs/tools/gate) and the other will be able to be updated through the Luos network by hosting a bootloader.
:::warning -If any problem occurs during the loading process, please reboot your system and retry typing the command (you can also find information [here](/docs/test/tools/boot)). +If any problem occurs during the loading process, please reboot your system and retry typing the command (you can also find information [here](/docs/tools/boot)). ::: Then relaunch a detection (as done in **Step 3**): @@ -154,4 +154,4 @@ You should see your updated service running in your node:
-You have reached the end of this tutorial. You are now able to use the bootloader's feature included in Luos engine. You know the basics, but you can find some more helpful information on the dedicated [documentation page](/docs/test/tools/boot). +You have reached the end of this tutorial. You are now able to use the bootloader's feature included in Luos engine. You know the basics, but you can find some more helpful information on the dedicated [documentation page](/docs/tools/boot). diff --git a/apps/documentation/tutorials/bootloader/intro.mdx b/apps/documentation/tutorials/bootloader/intro.mdx index abdd8fae..34d45388 100644 --- a/apps/documentation/tutorials/bootloader/intro.mdx +++ b/apps/documentation/tutorials/bootloader/intro.mdx @@ -25,7 +25,7 @@ import Introduction from '@site/src/components/school/article/intro.js'; }, { label: 'Luos Basics', - link: useBaseUrl('/docs/test/luos-technology/basics'), + link: useBaseUrl('/docs/luos-technology/basics'), }, ]} ressources={[ diff --git a/apps/documentation/tutorials/esp/connect.mdx b/apps/documentation/tutorials/esp/connect.mdx index 561de55a..5a4b3db1 100644 --- a/apps/documentation/tutorials/esp/connect.mdx +++ b/apps/documentation/tutorials/esp/connect.mdx @@ -51,7 +51,7 @@ Through this network, called Robus, you can send and receive messages between se This HAL provides a systick, a timestamp data API and a communication bus based on UART, TIMER and GPIO. -This ESP32 becomes a **node** on the Luos network and must be connected with other nodes by a physical layer: a wire or an RS485 bus. [Read our documentation for more information on hardware](https://www.luos.io/docs/test/hardware-consideration/electronics). +This ESP32 becomes a **node** on the Luos network and must be connected with other nodes by a physical layer: a wire or an RS485 bus. [Read our documentation for more information on hardware](https://www.luos.io/docs/hardware-consideration/electronics). ## 2. ESP32 development board's pins diff --git a/apps/documentation/tutorials/esp/esp.mdx b/apps/documentation/tutorials/esp/esp.mdx index f5a40086..d2f5537b 100644 --- a/apps/documentation/tutorials/esp/esp.mdx +++ b/apps/documentation/tutorials/esp/esp.mdx @@ -23,7 +23,7 @@ import Introduction from '@site/src/components/school/article/intro.js'; { label: 'Luos Get Started', link: useBaseUrl('/tutorials/get-started') }, { label: 'Luos basics', - link: useBaseUrl('/docs/test/luos-technology/basics'), + link: useBaseUrl('/docs/luos-technology/basics'), }, { label: 'PlateformIo tutorial', diff --git a/apps/documentation/tutorials/freertos/intro.mdx b/apps/documentation/tutorials/freertos/intro.mdx index d0b5f2a3..32cf345c 100644 --- a/apps/documentation/tutorials/freertos/intro.mdx +++ b/apps/documentation/tutorials/freertos/intro.mdx @@ -25,7 +25,7 @@ import Introduction from '@site/src/components/school/article/intro.js'; }, { label: 'Luos Basics', - link: useBaseUrl('/docs/test/luos-technology/basics'), + link: useBaseUrl('/docs/luos-technology/basics'), }, ]} ressources={[ diff --git a/apps/documentation/tutorials/get-started/get-started1.mdx b/apps/documentation/tutorials/get-started/get-started1.mdx index f9358e87..d9e69f8e 100644 --- a/apps/documentation/tutorials/get-started/get-started1.mdx +++ b/apps/documentation/tutorials/get-started/get-started1.mdx @@ -142,7 +142,7 @@ Congratulations, your first Luos app is running! ## 6. Explanation: What has been going on? -Two [services](/docs/test/luos-technology/services) have been loaded in your board on step 5, allowing you to make the LED blink. +Two [services](/docs/luos-technology/services) have been loaded in your board on step 5, allowing you to make the LED blink. - **Blinker** sends a message at a fixed duration.
╰ The code folder of this service is located at the root of the _get_started_ repository (because the same app can run on any board so it's a shared folder) - **Led** receives this message and makes the LED blink.
╰ The code folder of this service is located on the _lib_ folder of your project (because it is a driver which is specific to your board) diff --git a/apps/documentation/tutorials/get-started/get-started2.mdx b/apps/documentation/tutorials/get-started/get-started2.mdx index f23b320a..7c70a429 100644 --- a/apps/documentation/tutorials/get-started/get-started2.mdx +++ b/apps/documentation/tutorials/get-started/get-started2.mdx @@ -135,7 +135,7 @@ You can always check the list of the commands available for all services using y /> -See [Pyluos](/docs/test/tools/pyluos) documentation for more information. +See [Pyluos](/docs/tools/pyluos) documentation for more information. ::: diff --git a/apps/documentation/tutorials/get-started/get-started3.mdx b/apps/documentation/tutorials/get-started/get-started3.mdx index c5e16a79..40121d58 100644 --- a/apps/documentation/tutorials/get-started/get-started3.mdx +++ b/apps/documentation/tutorials/get-started/get-started3.mdx @@ -36,13 +36,13 @@ As we saw in Part 1, Luos engine allows you to define services and use them toge Let's make a network with two boards! -In this part, we will use the “default wiring” defined by Luos to create a network of two MCUs. We will use a [OneWire network](/docs/test/hardware-consideration/electronics), limiting the circuit to simple wires and pins: +In this part, we will use the “default wiring” defined by Luos to create a network of two MCUs. We will use a [OneWire network](/docs/hardware-consideration/electronics), limiting the circuit to simple wires and pins: - Tx and Rx pins, which are connected together and wired to the Tx and Rx pins of the other board (see the next image). - One PTP wire. :::tip -💡 Luos Point-To-Point (PTP) connection allows to find your board's [physical position](/docs/test/luos-technology/node/topology). Luos engine can deal with up to 8 PTP lines on each board to connect as many boards as you want. +💡 Luos Point-To-Point (PTP) connection allows to find your board's [physical position](/docs/luos-technology/node/topology). Luos engine can deal with up to 8 PTP lines on each board to connect as many boards as you want. ::: @@ -298,6 +298,6 @@ In this Get started tutorial, we used the default network used by Luos engine ca The next step will show you how to visualize your network online through the Luos Network Display tool. -You can check out our [tutorials](/tutorials) to learn more about Luos and understand how to use the features of Luos engine. We also invite you to check out our [documentation](/docs/test/luos-technology) to learn more about the core concepts of Luos engine. +You can check out our [tutorials](/tutorials) to learn more about Luos and understand how to use the features of Luos engine. We also invite you to check out our [documentation](/docs/luos-technology) to learn more about the core concepts of Luos engine. ⭐ If you liked this tutorial, feel free to star our Luos engine repository⭐ diff --git a/apps/documentation/tutorials/get-started/get-started4.mdx b/apps/documentation/tutorials/get-started/get-started4.mdx index 7b87430e..1c2206ef 100644 --- a/apps/documentation/tutorials/get-started/get-started4.mdx +++ b/apps/documentation/tutorials/get-started/get-started4.mdx @@ -219,6 +219,6 @@ Now unplug the USB cable of Board 1 and connect the USB cable of board 2. Then f **Congratulation, you succeed to visualize your network on the _Luos Network Display_ tool!** -You can check out our [tutorials](/tutorials) in our Academy section to learn more about Luos and understand how to use the features of Luos technology. We also invite you to check out our [documentation](/docs/test/luos-technology) to learn more about the core concepts of Luos. +You can check out our [tutorials](/tutorials) in our Academy section to learn more about Luos and understand how to use the features of Luos technology. We also invite you to check out our [documentation](/docs/luos-technology) to learn more about the core concepts of Luos. ⭐ If you liked this tutorial, feel free to star our Luos engine repository⭐ diff --git a/apps/documentation/tutorials/morse/add-service.mdx b/apps/documentation/tutorials/morse/add-service.mdx index 1e5e2182..b01005bb 100644 --- a/apps/documentation/tutorials/morse/add-service.mdx +++ b/apps/documentation/tutorials/morse/add-service.mdx @@ -48,7 +48,7 @@ For this reason it has the same basic functions that any other service: `Pipe_In In our project (if your remember well from the previous steps), the encoder application demanded to the pipe to be updated every 10ms. So the moment that we will integrate the pipe to the project, it will send the data (if they exist) to the encoder, every 10ms. :::info -If you want more information about the pipe, you can check the corresponding [documentation page](/docs/test/tools/gate). +If you want more information about the pipe, you can check the corresponding [documentation page](/docs/tools/gate). ::: :::tip diff --git a/apps/documentation/tutorials/pio/include.mdx b/apps/documentation/tutorials/pio/include.mdx index b6cf6057..cb24010a 100644 --- a/apps/documentation/tutorials/pio/include.mdx +++ b/apps/documentation/tutorials/pio/include.mdx @@ -122,7 +122,7 @@ Each API begins with the name of the file where it is declared. A simple rule of ## 3. Include Luos PTP interruption -In the case that you have a network, you need a way to detect other MCUs in this network. With the Luos network, we use two pins (see the documentation page [topology and network](/docs/test/luos-technology/node/topology) for more information). +In the case that you have a network, you need a way to detect other MCUs in this network. With the Luos network, we use two pins (see the documentation page [topology and network](/docs/luos-technology/node/topology) for more information). Those special pins, called PTP pins, are necessary for the topology detection. They need an interruption handler to work on a Luos network. diff --git a/apps/documentation/tutorials/resilient-alias/intro.mdx b/apps/documentation/tutorials/resilient-alias/intro.mdx index a7b4570f..1aa1faac 100644 --- a/apps/documentation/tutorials/resilient-alias/intro.mdx +++ b/apps/documentation/tutorials/resilient-alias/intro.mdx @@ -25,7 +25,7 @@ import Introduction from '@site/src/components/school/article/intro.js'; }, { label: 'Luos Basics', - link: useBaseUrl('/docs/test/luos-technology/basics'), + link: useBaseUrl('/docs/luos-technology/basics'), }, ]} ressources={[ diff --git a/apps/documentation/tutorials/your-first-detection/embedded-app.mdx b/apps/documentation/tutorials/your-first-detection/embedded-app.mdx index f9bf0cec..6c780cda 100644 --- a/apps/documentation/tutorials/your-first-detection/embedded-app.mdx +++ b/apps/documentation/tutorials/your-first-detection/embedded-app.mdx @@ -421,7 +421,7 @@ You can now detect all the services in your project and command them through an Now try to move your switcher package on another board, and keep the button and led packages on the first one: everything should work the same way! -Asking the value of the button every 10ms represents a not negligible portion of code. Luos engine provides an `update_time` command to simplify it, check the [documentation associated page](/docs/test/luos-technology/message/advanced-message) to learn more about it. +Asking the value of the button every 10ms represents a not negligible portion of code. Luos engine provides an `update_time` command to simplify it, check the [documentation associated page](/docs/luos-technology/message/advanced-message) to learn more about it. ## Test your skills diff --git a/apps/documentation/tutorials/your-first-detection/routing-table.mdx b/apps/documentation/tutorials/your-first-detection/routing-table.mdx index 2478c283..e3f7ab80 100644 --- a/apps/documentation/tutorials/your-first-detection/routing-table.mdx +++ b/apps/documentation/tutorials/your-first-detection/routing-table.mdx @@ -43,7 +43,7 @@ Instead of having defined IDs on your system, you can dynamically find them to m To find information on this routing table, Luos engine provides some filtering functions allowing you to extract the services depending on various criteria. You can cumulate those filtering functions to create complex searches and find the perfect resource fitting your needs. :::info -To learn more about routing table filters, feel free to check out [the related documentation page](/docs/test/luos-technology/services/routing-table). +To learn more about routing table filters, feel free to check out [the related documentation page](/docs/luos-technology/services/routing-table). ::: Instead of directly writing the ID of the led service at the end of the detection, let's find it and see how we can scale it easily! @@ -97,7 +97,7 @@ void Switcher_MsgHandler(service_t *service, msg_t *msg) ``` :::info -A field `result_nbr` (see **[search_result_t](/docs/test/luos-technology/services/routing-table)** structure) gives you the number matching your search. +A field `result_nbr` (see **[search_result_t](/docs/luos-technology/services/routing-table)** structure) gives you the number matching your search. For example, only one service have an alias “led” in our system, so `filter_result.result_nbr = 1;` returns the filtering (ID of led service) and is placed in the first case of a tab: `filter_result.result_table[0]`. Using this filtering, we can easily adapt our switcher code to be able to control as many led services we have on the network by sending the message in a loop until the **result_nbr** matches. ::: diff --git a/apps/documentation/tutorials/your-first-detection/topology.mdx b/apps/documentation/tutorials/your-first-detection/topology.mdx index 91fcc24d..c8cfcb54 100644 --- a/apps/documentation/tutorials/your-first-detection/topology.mdx +++ b/apps/documentation/tutorials/your-first-detection/topology.mdx @@ -53,7 +53,7 @@ To be able to use other services, we need to list them, define their position, a In the previous tutorials, the gate application was making the detection for you. Now it is time to emancipate from the gate and make the detection by yourself. :::info -More details about detections and topology are on [the related Luos documentation page](/docs/test/luos-technology/node/topology). +More details about detections and topology are on [the related Luos documentation page](/docs/luos-technology/node/topology). ::: To make a detection, Luos engine needs to know which service is requesting it. So we will need to pass the switcher service to the detection function. @@ -90,7 +90,7 @@ void Switcher_Init(void) ``` :::info -After using this API, Luos engine will assign a unique ID to each service in the system and create a routing table containing all the services' information present in the network: [ID, Alias](/docs/test/luos-technology/services), and [topology](/docs/test/luos-technology/node/topology). This routing table created by the service starting the detection is shared to the others. More details about the routing table can be found on the [dedicated Luos documentation page](/docs/test/luos-technology/services/routing-table). +After using this API, Luos engine will assign a unique ID to each service in the system and create a routing table containing all the services' information present in the network: [ID, Alias](/docs/luos-technology/services), and [topology](/docs/luos-technology/node/topology). This routing table created by the service starting the detection is shared to the others. More details about the routing table can be found on the [dedicated Luos documentation page](/docs/luos-technology/services/routing-table). ::: If you check your main files, you will see a switcher package and a led package. All those packages create only one service. The service performing the detection always has the ID 1 because this service will be the “root” of your system. So in our case, the switcher app will receive ID 1. Then, the other services will get the next ID following the creation order, so the led service will receive ID 2. diff --git a/apps/documentation/tutorials/your-first-detection/your-first-detection.mdx b/apps/documentation/tutorials/your-first-detection/your-first-detection.mdx index d79195f8..dec55c5b 100644 --- a/apps/documentation/tutorials/your-first-detection/your-first-detection.mdx +++ b/apps/documentation/tutorials/your-first-detection/your-first-detection.mdx @@ -26,7 +26,7 @@ import Introduction from '@site/src/components/school/article/intro.js'; }, { label: 'Luos Basics', - link: useBaseUrl('/docs/test/luos-technology/basics'), + link: useBaseUrl('/docs/luos-technology/basics'), }, { label: 'Your first service tutorial', diff --git a/apps/documentation/tutorials/your-first-message/send-message.mdx b/apps/documentation/tutorials/your-first-message/send-message.mdx index eae717d7..d3e173ad 100644 --- a/apps/documentation/tutorials/your-first-message/send-message.mdx +++ b/apps/documentation/tutorials/your-first-message/send-message.mdx @@ -89,7 +89,7 @@ The **Data** is the actual transmitted data. The **Header** contains some contextual information allowing the receiver to get the purpose of the Data. :::info -For more information about the messages, you can refer to [the related documentation page](https://docs.luos.io/docs/test/luos-technology/message). +For more information about the messages, you can refer to [the related documentation page](https://docs.luos.io/docs/luos-technology/message). ::: To send a message, you will need to fill in some header information regarding the target and the data of you message: diff --git a/apps/documentation/tutorials/your-first-message/your-first-message.mdx b/apps/documentation/tutorials/your-first-message/your-first-message.mdx index b35803e6..4601ac7d 100644 --- a/apps/documentation/tutorials/your-first-message/your-first-message.mdx +++ b/apps/documentation/tutorials/your-first-message/your-first-message.mdx @@ -26,7 +26,7 @@ import Introduction from '@site/src/components/school/article/intro.js'; }, { label: 'Luos Basics', - link: useBaseUrl('/docs/test/luos-technology/basics'), + link: useBaseUrl('/docs/luos-technology/basics'), }, { label: 'Your first service tutorial', diff --git a/apps/documentation/tutorials/your-first-service/create-a-package.mdx b/apps/documentation/tutorials/your-first-service/create-a-package.mdx index 87d9555d..38f72a89 100644 --- a/apps/documentation/tutorials/your-first-service/create-a-package.mdx +++ b/apps/documentation/tutorials/your-first-service/create-a-package.mdx @@ -16,7 +16,7 @@ If we want to be able to easily move our led service from one project to another The service you just created doesn't need any direct access to any other services on your network. But the other services still have the possibility to interact with it. This is the purpose of microservice: it is allowing you to have loosely coupled pieces of code. -Thanks to that, we can put the service in a folder, move it as we want, and share all our services extremely easily. We call it a [package](/docs/test/luos-technology/package). +Thanks to that, we can put the service in a folder, move it as we want, and share all our services extremely easily. We call it a [package](/docs/luos-technology/package). Packages also allow you to have plenty of code in your project while keeping it clean anyway! Let's see how to create one. diff --git a/apps/documentation/tutorials/your-first-service/luos-service.mdx b/apps/documentation/tutorials/your-first-service/luos-service.mdx index b030f9dd..b3618d2e 100644 --- a/apps/documentation/tutorials/your-first-service/luos-service.mdx +++ b/apps/documentation/tutorials/your-first-service/luos-service.mdx @@ -59,7 +59,7 @@ At any time, you can check the solution in the folder _Training/1_First_Service/ ::: -A service is an encapsulated feature defining an API and allowing other services to interact with it (see the [documentation](/docs/test/luos-technology/services)). +A service is an encapsulated feature defining an API and allowing other services to interact with it (see the [documentation](/docs/luos-technology/services)). In the case of a simple LED, your service will have one input with the state of the IO that turns the LED on or off: diff --git a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/advanced-message.mdx b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/advanced-message.mdx index bc8d4f7d..b2169806 100644 --- a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/advanced-message.mdx +++ b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/advanced-message.mdx @@ -117,7 +117,7 @@ You can play, pause, stop or record a stream flux with the standard **CONTROL** ## How to use it -**A streaming channel is always created by the strict real-time service.** The other service (the non-real-time one) will just send or receive its data chunks using [large data messages](/docs/test/luos-technology/message/advanced-message#large-data). +**A streaming channel is always created by the strict real-time service.** The other service (the non-real-time one) will just send or receive its data chunks using [large data messages](/docs/luos-technology/message/advanced-message#large-data). ### Streaming channel creation diff --git a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/command.mdx b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/command.mdx index 7bcfa9b7..79eeafaa 100644 --- a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/command.mdx +++ b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/message/command.mdx @@ -10,7 +10,7 @@ import IconExternalLink from '@theme/Icon/ExternalLink'; Each message includes a command value that defines the content's type of the message's data. -Another feature included in Luos engine is the [Object Dictionary (OD)](/docs/test/luos-technology/message/object-dictionary), which aims to maintain interoperability of data format and command's type between services. +Another feature included in Luos engine is the [Object Dictionary (OD)](/docs/luos-technology/message/object-dictionary), which aims to maintain interoperability of data format and command's type between services. ## Commands diff --git a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/luos-hal.mdx b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/luos-hal.mdx index 5ce0f3b0..71e27dff 100644 --- a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/luos-hal.mdx +++ b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/luos-hal.mdx @@ -7,7 +7,7 @@ custom_edit_url: null Luos engine can work on a single node using localhost communication or it can create a network for communication between services located on different nodes. This communication should be defined and hardware-configured to fit with the chosen MCU. The files _luos_hal.c_ and _luos_hal.h_ define all the functions needed by Luos engine. Then, there is a HAL depending on the network layer you use to send messages through the physical bus. -The file _luos_hal_config.h_ contains a default configuration for an MCU family and can be redefined in a configuration file to fit your design. The configuration of Luos engine HAL is described [here](/docs/test/hardware-consideration/mcu). +The file _luos_hal_config.h_ contains a default configuration for an MCU family and can be redefined in a configuration file to fit your design. The configuration of Luos engine HAL is described [here](/docs/hardware-consideration/mcu). ## Luos engine's HAL diff --git a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/topology.mdx b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/topology.mdx index 744768a4..11007447 100644 --- a/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/topology.mdx +++ b/apps/documentation/versioned_docs/version-2.5.0/luos-technology/node/topology.mdx @@ -13,14 +13,14 @@ The nodes can access the position of every other node in the network at any time This routing table allows any service to find, locate, and use any other service on the entire network. -## [Routing Table](/docs/test/luos-technology/services/routing-table) +## [Routing Table](/docs/luos-technology/services/routing-table) -The [Routing Table](/docs/test/luos-technology/services/routing-table) is a feature of Luos allowing every node to own a "map" (or topology) of the entire network of your device. This map allows nodes to know their physical position and different functionalities, as well as to easily search and interact with the other nodes. +The [Routing Table](/docs/luos-technology/services/routing-table) is a feature of Luos allowing every node to own a "map" (or topology) of the entire network of your device. This map allows nodes to know their physical position and different functionalities, as well as to easily search and interact with the other nodes. -The [Routing Table](/docs/test/luos-technology/services/routing-table) is designed and shared among all the nodes after a process that is called [detection](/docs/test/luos-technology/services/routing-table). +The [Routing Table](/docs/luos-technology/services/routing-table) is designed and shared among all the nodes after a process that is called [detection](/docs/luos-technology/services/routing-table). :::info -More details about routing table on the [dedicated page](/docs/test/luos-technology/services/routing-table). +More details about routing table on the [dedicated page](/docs/luos-technology/services/routing-table). ::: ## PTP Network diff --git a/apps/documentation/versioned_docs/version-2.5.0/tools/gate.mdx b/apps/documentation/versioned_docs/version-2.5.0/tools/gate.mdx index d353fbd7..f5e4a12f 100644 --- a/apps/documentation/versioned_docs/version-2.5.0/tools/gate.mdx +++ b/apps/documentation/versioned_docs/version-2.5.0/tools/gate.mdx @@ -11,7 +11,7 @@ import Image from '@site/src/components/Image.js'; The gate is a major tool of the Luos ecosystem. It is allowing you to translate any Luos architecture into a more convenient format for standard software ([JSON] most of the time) and to stream and receive this formatted information into any kind of communication way such as serial interface, WiFi, Bluetooth, Lora, ... -You can use it to take control of any embedded service with [any languages](/docs/test/api) on any machine. For example, we use it in [Pyluos](/docs/test/tools/pyluos) or [ROS](/docs/test/tools/ros). +You can use it to take control of any embedded service with [any languages](/docs/api) on any machine. For example, we use it in [Pyluos](/docs/tools/pyluos) or [ROS](/docs/tools/ros). The gate is a simple embedded [app service](../luos-technology/services/service-api#apps-guidelines), so it can work on any MCU running Luos without any modification. @@ -77,7 +77,7 @@ When the gate and the pipe are on separate nodes, formated messages transit into ## The gate configurations -The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/test/luos-technology/basics/orga#configuration). +The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/luos-technology/basics/orga#configuration). You could need to change it if you have apps on your Luos embedded system. diff --git a/apps/documentation/versioned_docs/version-2.5.0/tools/index.mdx b/apps/documentation/versioned_docs/version-2.5.0/tools/index.mdx index e581fb79..6c2c9bf6 100644 --- a/apps/documentation/versioned_docs/version-2.5.0/tools/index.mdx +++ b/apps/documentation/versioned_docs/version-2.5.0/tools/index.mdx @@ -7,13 +7,13 @@ description: Luos provides many tools to interface, control, or monitor products Luos provides many tools to interface, control, or monitor products made with Luos engine. -| Services | Description | -| :---------------------------: | :---------------------------------------------------------------------------------------------------: | -| [Gate](/docs/test/tools/gate) | A translation Luos app service allowing you to easily connect your computer to your hardware product. | -| Inspector | A Luos service application allowing a computer to inspect a product. | +| Services | Description | +| :----------------------------------: | :-------------------------------------------------------------------------------------: | +| [Gate](/docs/tools/gate) | A translation Luos app service allowing you to easily connect your computer to your hardware product. | +| Inspector | A Luos service application allowing a computer to inspect a product. | -| Tools | Description | -| :---------------------------------------: | :----------------------------------------------------: | -| [Pyluos](/docs/test/tools/pyluos) | Python library using JSON API to communicate with gate | -| [BootLoder](/docs/test/tools/boot) | Update node through Luos Network | -| [Monitoring](/docs/test/tools/monitoring) | API that allows you to monitor a Luos network | +| Tools | Description | +| :----------------------------------: | :-------------------------------------------------------------------------------------: | +| [Pyluos](/docs/tools/pyluos) | Python library using JSON API to communicate with gate | +| [BootLoder](/docs/tools/boot) | Update node through Luos Network | +| [Monitoring](/docs/tools/monitoring) | API that allows you to monitor a Luos network | diff --git a/apps/documentation/versioned_docs/version-2.5.0/tools/inspector.mdx b/apps/documentation/versioned_docs/version-2.5.0/tools/inspector.mdx index a838345a..7e420bd3 100644 --- a/apps/documentation/versioned_docs/version-2.5.0/tools/inspector.mdx +++ b/apps/documentation/versioned_docs/version-2.5.0/tools/inspector.mdx @@ -53,7 +53,7 @@ int main(void) ## The inspector configurations -The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/test/luos-technology/basics/orga#configuration). +The default process described above can be changed using different configurations that you can use in [the file _node_config.h_](/docs/luos-technology/basics/orga#configuration). You could need to change it if you have apps on you Luos embedded system. @@ -65,7 +65,7 @@ If you have an app service on your device managing detection, you should define ## Inspector vs. gate -As for the gate, the inspector needs a pipe to transfer information outside the Luos network. The pipe and inspector can be hosted into the same node or on different nodes in the network. It is recommended to have an inspector and a pipe on the same node to avoid overloading the Luos network with messages that can be handled locally on the node (see the [gate page](/docs/test/tools/gate) for more information). +As for the gate, the inspector needs a pipe to transfer information outside the Luos network. The pipe and inspector can be hosted into the same node or on different nodes in the network. It is recommended to have an inspector and a pipe on the same node to avoid overloading the Luos network with messages that can be handled locally on the node (see the [gate page](/docs/tools/gate) for more information). The inspector can be used with the gate in a network, the gate taking control of the sensors and the inspector displaying all the information, for example.