Update home authored by tmonteil's avatar tmonteil
...@@ -4,11 +4,10 @@ LOM2M is a message oriented middleware implementing the oneM2M standard and its ...@@ -4,11 +4,10 @@ LOM2M is a message oriented middleware implementing the oneM2M standard and its
Have a look to LOM2M [technical sheet](uploads/1c68a72e2a18adb196200f3676d3d5fe/LOM2M.pdf). Have a look to LOM2M [technical sheet](uploads/1c68a72e2a18adb196200f3676d3d5fe/LOM2M.pdf).
Most of the acronyms used in this wiki are oneM2M acronyms. To refer to those acronyms cf. oneM2M technical specifications. Most of the acronyms used in this wiki are oneM2M acronyms. To refer to those acronyms cf. oneM2M technical specifications. Some of them are defined again here:
Some of them are defined again here:
| Acronym | Definition | | Acronym | Definition |
| ------ | ------ | |---------|------------|
| IoT | Internet of Things | | IoT | Internet of Things |
| CSE | Common Service Entity | | CSE | Common Service Entity |
| IN | Infrastructure Node | | IN | Infrastructure Node |
...@@ -17,7 +16,7 @@ Some of them are defined again here: ...@@ -17,7 +16,7 @@ Some of them are defined again here:
**Default configuration**: **Default configuration**:
| Config | Value | | Config | Value |
| ------ | ------ | |--------|-------|
| HTTP port | `8282` | | HTTP port | `8282` |
| Originator AE Admin | `admin:admin` | | Originator AE Admin | `admin:admin` |
| Remote CSE ID | `in-cse` | | Remote CSE ID | `in-cse` |
...@@ -29,55 +28,62 @@ Some of them are defined again here: ...@@ -29,55 +28,62 @@ Some of them are defined again here:
(These values can be changed at build time or dynamically on UNIX targets) (These values can be changed at build time or dynamically on UNIX targets)
# Target deployment # Target deployment
The typical target deployment is a power constrained gateway (microcontroller).
Here are some example of memory usage regarding the target: The typical target deployment is a power constrained gateway (microcontroller). Here are some example of memory usage regarding the target:
**MCU ESP8266**: **MCU ESP8266**:
- ~500KB (sketch)
- ~50KB RAM - \~500KB (sketch)
- \~50KB RAM
**UNIX based systems**: **UNIX based systems**:
- at least 5MB storage (executable size) - at least 5MB storage (executable size)
- at least 3MB RAM - at least 3MB RAM
**DOCKER container**: **DOCKER container**:
- at least ~10MB for compressed image (precompiled)
LOM2M Dockerfile is based on alpine to run the compiled executable. - at least \~10MB for compressed image (precompiled) LOM2M Dockerfile is based on alpine to run the compiled executable.
(These sizes may vary regarding to the enabled features) (These sizes may vary regarding to the enabled features)
# Resources # Resources
## Global Resources ## Global Resources
- [Install & Launch](LOM2M/Install, configure and launch)
- [Features & Capabilities](LOM2M/Features and capabilities) - [Install & Launch](LOM2M/Install,%20configure%20and%20launch)
- [Features & Capabilities](LOM2M/Features%20and%20capabilities)
- [Global behavior](LOM2M/LOM2M-Global-behavior) - [Global behavior](LOM2M/LOM2M-Global-behavior)
- [Documents: Software Design Document, test reports, etc.](LOM2M/project-documents) - [Documents: Software Design Document, test reports, etc.](LOM2M/project-documents)
## Specific feature documentation ## Specific feature documentation (not included in opensource version)
- [Integration with AWS IoT Core device management & provisionning](LOM2M/AWS IoT Core Device provisionning)
- [Integration with AWS IoT Core device management & provisionning](LOM2M/AWS%20IoT%20Core%20Device%20provisionning)
- [MQTTS binding](LOM2M/Features-and-capabilities/MQTT-Binding) - [MQTTS binding](LOM2M/Features-and-capabilities/MQTT-Binding)
Node-RED nodes: Node-RED nodes:
- [Node-RED documentation](LOM2M/Node-RED) - [Node-RED documentation](LOM2M/Node-RED)
AI works: AI works:
- [NVIDIA Jetson Nano DK & GPU](LOM2M/Nvidia Jetson Nano Developer Kit & GPU)
- [NVIDIA Jetson Nano DK & GPU](LOM2M/Nvidia%20Jetson%20Nano%20Developer%20Kit%20&%20GPU)
## Gitlab configuration, Continuous Integration (CI) ## Gitlab configuration, Continuous Integration (CI)
A continuous integration is enabled on the project. A continuous integration is enabled on the project. It is configured to trigger different tasks regarding commits, merge requests, etc. For more details about this configuration, cf.:
It is configured to trigger different tasks regarding commits, merge requests, etc.
For more details about this configuration, cf.:
- [Gitlab configuration CI/CD](LOM2M/Gitlab configuration and CI-CD)
- [Gitlab configuration CI/CD](LOM2M/Gitlab%20configuration%20and%20CI-CD)
## Other information ## Other information
### Details around LOM2M project ### Details around LOM2M project
- [External librairies and licenses](LOM2M/Librairies & licenses)
- [External librairies and licenses](LOM2M/Librairies%20&%20licenses)
- [ESP8266 Documentation](https://arduino-esp8266.readthedocs.io/en/latest/index.html) - [ESP8266 Documentation](https://arduino-esp8266.readthedocs.io/en/latest/index.html)
### References to oneM2M specifications ### References to oneM2M specifications
- TS 0001: [oneM2M Architecture](https://onem2m.org/images/files/deliverables/Release3/TS-0001-Functional_Architecture-V3_15_1.pdf) - TS 0001: [oneM2M Architecture](https://onem2m.org/images/files/deliverables/Release3/TS-0001-Functional_Architecture-V3_15_1.pdf)
- TS 0004: [oneM2M Protocol](https://onem2m.org/images/files/deliverables/Release3/TS-0004_Service_Layer_Core_Protocol_V3_11_2.zip) - TS 0004: [oneM2M Protocol](https://onem2m.org/images/files/deliverables/Release3/TS-0004_Service_Layer_Core_Protocol_V3_11_2.zip)
... ...
......