Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: fixes doc firmware #291

Merged
merged 1 commit into from
Jul 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 38 additions & 9 deletions firmware/doc.txt
Original file line number Diff line number Diff line change
@@ -1,18 +1,47 @@
/**
@defgroup m4a-firmware Reference firmware

### What goes here?
Specific documentation for our reference firmware ; m4a-firmware
### Firmware

You can find specific documentation for the sys, peripherals, and network folders.
This is the core of Mesh4All, you can find specific documentation for the sys, peripherals, and network folders.

### Network

### network
UDP client, UDP server.
This section has modules like:

### peripherals
Humidity and temperature sensors.
- UDP client: Make use of Internet Protocol of the TCP/IP suit.

### sys
AT commands, udp serialization, storage, ipv6 address.
- UDP server: Process all request sent by an udp client device.

- RPL protocol: The functions to start RPL and add a node dodag (Root)
or dag (Slave).

- Radio: Module that handles all low power and low consumption wireless devices.

- Net tools: Contains all about networks tools.

- Chamos (Communication Handler for Addressing Management | Origin Server): It's used for
server-side communication.

- Border Router: The module sets an IPV6 address in a wireless or wired interface.

### Peripherals

- Moisture sensor: Gets humidity and temperature data of a certain environment.

- Temperature sensor (DS18): Get the data of the temperature sensor.

### Sys

- AT commands: Establish a connection with a wifi-subsystem, which handles AT commands
sent through the shell.

- Serialization: Get and decode a data of the sensors arrived from udp server and decodes
the message before sending it to udp client. This implementation uses a library tinycbor.

- Storage: Saves data in the flash memory in pages that we can write and read, the max size
to save is 16 page.

- Unique_id: Get a specific id for each device and you have three options to get an unique
IPV6 address (static, random, custom).
*/
6 changes: 3 additions & 3 deletions firmware/network/radio/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

### Radio

In this module are all low power and low consumption wireless device,
In this module are all low power and low consumption wireless devices,
it can find devices based on the zigbee and 6lowpan protocols,
In addition to that, these devices can follow the guidelines established in
the IEEE802.14.5 standard.
Expand All @@ -16,11 +16,11 @@ it's between the range of 11 to 26 and in the case of the radio device is multib
you could works in the band under to 2.4GHz these channels are between 0 and 10.

The functionalities of the radio module allow to obtain and configure the characteristics of
the wireless networkInterface. This allows knowing the current state of the physical
the wireless network interface. This allows knowing the current state of the physical
configuration and manipulating it to obtain the better optimization.

The radio module includes a kconfig setup, this means to could be obtained an statically setup
of any device, also the kconfig, and the module it's adjusted to the specified device. this features
of any device, also the kconfig, and the module it's adjusted to the specified device. These features
are provided by the following table:

| Driver |TX_POWER_MIN (dBm) | TX_POWER_MAX (dBm)|Dual band | channel range ||
Expand Down
2 changes: 1 addition & 1 deletion firmware/sys/at_client/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### At client

You have at command handler, which can be send with the shell, the following list has the command options:
You have AT commands handler, which can be send with the shell, the following list has the command options:

### Shell commands

Expand Down