| Internet Engineering Task Force | A. Minaburo, Ed. |
| Internet-Draft | Acklio |
| Intended status: Informational | L. Toutain |
| Expires: December 17, 2016 | Telecom Bretagne |
| Y. Delibie | |
| Kerlink | |
| June 15, 2016 |
YANG module for LoRa Networks
draft-minaburo-6lpwa-yang-lora-01
This document presents a YANG module definition for managing LoRa-based devices.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 17, 2016.
Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
This document provides a YANG module description for managing a LoRa endpoints.
SemTech [LoRa] (c) is a low-rate, low-power, long-range radio technology. It could be used as a base radio technology for building Low-Rate Wide-Area Networks (LR-WAN), also known as LPWA (Low-Power Wide Area). SemTech [LoRa] (c) has the following characteristics:
The management of LoRa-based devices can be done through a standard approach, compatible with the best network-operator practices, namely NETCONF or RESTCONF. A formal definition of the parameters and the values to be managed is thus required, which can be done with the YANG module language. The following document presents a YANG module definition for managing a LoRa-based end-device.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119].
The data model has the following structure for Lora configuration:
module: ietf-lora
+--rw lora
+--rw channel-bandwidth? enumeration
+--rw coding-rate? enumeration
+--rw spreading-factor? uint8
+--rw physical-layer
| +--rw preamble-length? int32
| +--rw channel-frequency-range enumeration
| +--rw channel? uint8
| +--rw symbol-timeout? uint32
+--rw mac-layer
+--rw payload-encryption? boolean
+--rw delay? int32
+--rw fixed-length-payload? boolean
The data model defines a state container Mode which include the three principal characteristics of the LoRA interface which determine the parameters of the channel
Figure 1
This model imports typedefs from [RFC6991].
<CODE BEGINS> file "ietf-lora"
module ietf-lora {
namespace "urn:ietf:params:xml:ns:yang:ietf-lora";
prefix lora;
organization "Acklio";
contact "Ana Minaburo ana@minaburo.com";
description
"This module contains a collection of YANG definitions for
configuring the LORA () network interface.
Copyright (c) 2015 IETF Trust and the persons identified as
authors of the code. All right reserved.
Redistribution and use in source binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
Relating to IETF Documents
(http://trustee.ietf.org/license-info)
This YANG module version is part of draft-minaburo-6lpwa-cosol-00;
see the draft itself for full legal notices.";
revision 2016-06-01 {
description "Initial Description";
reference "LoRa MAC Class A Specification R3.1 by Semtech";
}
grouping mode {
description " ToDO";
leaf channel-bandwidth {
type enumeration {
enum 125 { value 0; description "125 KHz";}
enum 150 { value 1; description "150 KHz";}
enum 500 { value 2; description "500 KHz";}
}
description "Physical Channel Bandwidth";
}
leaf coding-rate {
type enumeration {
enum 4_5 { value 1; description ""; }
enum 4_6 { value 2; description ""; }
enum 4_7 { value 3; description ""; }
enum 4_b { value 4; description ""; }
}
description "LORA error correction scheme";
}
leaf spreading-factor {
type uint8 {
range "6 .. 12";
}
description "Modulation to enable spread signals";
}
}
container lora {
description "LORA channel";
uses lora:mode;
container physical-layer {
description "LORA phisical layer";
leaf preamble-length {
type int32;
default 7;
description "Header packet definition";
}
leaf channel-frequency-range {
type enumeration {
enum europe { value 1; description "";}
enum usa { value 2; description "";}
enum japan { value 3; description "";}
enum china { value 4; description "";}
}
mandatory true;
description "Band Choice depends on Country";
}
leaf channel {
type uint8 {
range "0..10";
}
description "Physical Channels";
}
leaf symbol-timeout {
type uint32;
description "Waiting the free band";
}
}
container mac-layer {
description " LORA MAC layer format";
leaf payload-encryption {
type boolean;
default "false";
description "Known if the encryption is used";
}
leaf delay {
type int32;
description "Delay value";
}
leaf fixed-length-payload {
type boolean;
default "false";
description "If Modulation is not variable";
}
}
}
}
<CODE ENDS>
The data model defines a state container Mode which include the three principal characteristics of the LoRA interface which determine the parameters of the channel
Figure 2
We want to thank Alexander Pelov for all his inputs and corrections to this work
This memo includes no request to IANA.
All drafts are required to have a security considerations section. See RFC 3552 [RFC3552] for a guide. TO DO
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997. |
| [LoRa] | Semtech, "https://web.archive.org/web/20150510011904/https://www.semtech.com/wireless-rf/lora.html", May 2015. |
| [RFC3552] | Rescorla, E. and B. Korver, "Guidelines for Writing RFC Text on Security Considerations", BCP 72, RFC 3552, DOI 10.17487/RFC3552, July 2003. |