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.

Sign up for GitHub

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

[ON HOLD] Updated Document for installation guide and usernamual #602

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[ON HOLD] Updated Document for installation guide and usernamual #602

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e63621
Update usermanual.md
KeshavSoni2511 Apr 24, 2023
9f1ace0
Update installationguide.md
KeshavSoni2511 Apr 24, 2023
09861c3
Update usermanual.md
KeshavSoni2511 Apr 27, 2023
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
32 changes: 17 additions & 15 deletions docs/installationguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <version-number> -r <release-number>
```

Where `<version-number>` is the version (x.y.z) you want the package to have and `<release-number>` 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:

Expand Down Expand Up @@ -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 <version-number> -r <release-number>
```

Where `<version-number>` is the version (x.y.z) you want the package to have and `<release-number>` is an increasing
number dependent un previous installations.
5 changes: 2 additions & 3 deletions docs/usermanual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
KeshavSoni2511 marked this conversation as resolved.
Show resolved Hide resolved

### Ultralight 2.0 Protocol

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down