From 2e636217e8d7b1e25a96d358bc9c0ab7577f5cff Mon Sep 17 00:00:00 2001 From: Keshav-NEC <102344018+Keshav-NEC@users.noreply.github.com> Date: Mon, 24 Apr 2023 13:36:08 +0530 Subject: [PATCH 1/3] Update usermanual.md Document improved #195 --- docs/usermanual.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/usermanual.md b/docs/usermanual.md index 91854528..82535815 100644 --- a/docs/usermanual.md +++ b/docs/usermanual.md @@ -9,7 +9,7 @@ ## API Overview This section describes the specific South-bound API implemented by this IoTAgent. For the Configuration API and other -APIs concerning general IoTAgents, check the [API Reference section](#apireference); +APIs concerning general IoTAgents, check the [API Reference section](https://github.com/Keshav-NEC/iotagent-ul/blob/master/README.md#install). ### Ultralight 2.0 Protocol @@ -47,7 +47,7 @@ Measure groups can additionally have an optional timestamp, with the following s ``` The timestamp will be added as a prefix of the measures themselves, separated by a '|'. The attribute will be translated -to a `TimeInstant` attribute in the final entity.T +to a `TimeInstant` attribute in the final entity. #### Active versus passive attributes @@ -334,7 +334,6 @@ by the protocol, in this case '/ul', just include apikey and deviceid (e.g: `/FF > receive commands in an appropriate format. -This transport protocol binding is still under development. ##### Sending a single measure in one message From 9f1ace019beebade8fafc75ccaec545fc7bc05a1 Mon Sep 17 00:00:00 2001 From: Keshav-NEC <102344018+Keshav-NEC@users.noreply.github.com> Date: Mon, 24 Apr 2023 14:08:55 +0530 Subject: [PATCH 2/3] Update installationguide.md Doc improved #195 --- docs/installationguide.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/installationguide.md b/docs/installationguide.md index 2cf227c3..cd48f081 100644 --- a/docs/installationguide.md +++ b/docs/installationguide.md @@ -129,23 +129,10 @@ In this mode, the log file is written in `/var/log/iotaul/iotaul.log`. The Docker automatically starts listening in the API ports, so there is no need to execute any process in order to have the application running. The Docker image will automatically start. -## Packaging - -The only package type allowed is RPM. In order to execute the packaging scripts, the RPM Build Tools must be available -in the system. - -From the root folder of the project, create the RPM with the following commands: - -```bash -cd rpm -./create-rpm.sh -v -r -``` - -Where `` is the version (x.y.z) you want the package to have and `` is an increasing -number dependent un previous installations. - ## Configuration +#### Overview + All the configuration for the IoT Agent resides in the `config.js` file, in the root of the application. This file is a JavaScript file, that contains the following sections: @@ -416,3 +403,18 @@ It means that we need to make some changes in the execution of node.js and in th net.nf_conntrack_max = 1048576 For more details about any other kernel parameters, take a look to the example [sysctl.conf](sysctl.conf) file. + +## Packaging + +The only package type allowed is RPM. In order to execute the packaging scripts, the RPM Build Tools must be available +in the system. + +From the root folder of the project, create the RPM with the following commands: + +```bash +cd rpm +./create-rpm.sh -v -r +``` + +Where `` is the version (x.y.z) you want the package to have and `` is an increasing +number dependent un previous installations. From 09861c369c1c218daf449f5830270d9e8efec776 Mon Sep 17 00:00:00 2001 From: Keshav-NEC <102344018+Keshav-NEC@users.noreply.github.com> Date: Thu, 27 Apr 2023 13:46:55 +0530 Subject: [PATCH 3/3] Update usermanual.md Resolved with master branch link. Sorry for the wrong commit. --- docs/usermanual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usermanual.md b/docs/usermanual.md index 82535815..5a029aa4 100644 --- a/docs/usermanual.md +++ b/docs/usermanual.md @@ -9,7 +9,7 @@ ## API Overview This section describes the specific South-bound API implemented by this IoTAgent. For the Configuration API and other -APIs concerning general IoTAgents, check the [API Reference section](https://github.com/Keshav-NEC/iotagent-ul/blob/master/README.md#install). +APIs concerning general IoTAgents, check the [API Reference section](https://github.com/telefonicaid/iotagent-ul/blob/master/README.md#api). ### Ultralight 2.0 Protocol