idnits 2.17.1 draft-minaburo-6lpwa-yang-lora-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 110 has weird spacing: '...y-range enu...' == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document date (June 15, 2016) is 2870 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Missing Reference: 'RFC6991' is mentioned on line 126, but not defined Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force A. Minaburo, Ed. 3 Internet-Draft Acklio 4 Intended status: Informational L. Toutain 5 Expires: December 17, 2016 Telecom Bretagne 6 Y. Delibie 7 Kerlink 8 June 15, 2016 10 YANG module for LoRa Networks 11 draft-minaburo-6lpwa-yang-lora-01 13 Abstract 15 This document presents a YANG module definition for managing LoRa- 16 based devices. 18 Status of This Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at http://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on December 17, 2016. 35 Copyright Notice 37 Copyright (c) 2016 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents 42 (http://trustee.ietf.org/license-info) in effect on the date of 43 publication of this document. Please review these documents 44 carefully, as they describe your rights and restrictions with respect 45 to this document. Code Components extracted from this document must 46 include Simplified BSD License text as described in Section 4.e of 47 the Trust Legal Provisions and are provided without warranty as 48 described in the Simplified BSD License. 50 Table of Contents 52 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 53 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 54 2. LoRa Data Model . . . . . . . . . . . . . . . . . . . . . . . 3 55 3. LoRa YANG module . . . . . . . . . . . . . . . . . . . . . . 3 56 4. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6 57 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 58 6. Security Considerations . . . . . . . . . . . . . . . . . . . 6 59 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 60 7.1. Normative References . . . . . . . . . . . . . . . . . . 6 61 7.2. Informative References . . . . . . . . . . . . . . . . . 6 62 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 64 1. Introduction 66 This document provides a YANG module description for managing a LoRa 67 endpoints. 69 SemTech [LoRa] (c) is a low-rate, low-power, long-range radio 70 technology. It could be used as a base radio technology for building 71 Low-Rate Wide-Area Networks (LR-WAN), also known as LPWA (Low-Power 72 Wide Area). SemTech [LoRa] (c) has the following characteristics: 74 o Works in narrow, license-free (ISM) bands with good propagation 75 properties (< 1GHz) 77 o Low- to very-low throughput (270 bps--200 kbps) 79 o Low-power operation (25 mW in Europe) 81 o Far-Reaching communication capabilities (20 km with line-of-sight, 82 several km in urban environment) 84 o Strong channel access restrictions (1% to 10% duty cycling) 86 The management of LoRa-based devices can be done through a standard 87 approach, compatible with the best network-operator practices, namely 88 NETCONF or RESTCONF. A formal definition of the parameters and the 89 values to be managed is thus required, which can be done with the 90 YANG module language. The following document presents a YANG module 91 definition for managing a LoRa-based end-device. 93 1.1. Requirements Language 95 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 96 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 97 document are to be interpreted as described in RFC 2119 [RFC2119]. 99 2. LoRa Data Model 101 The data model has the following structure for Lora configuration: 103 module: ietf-lora 104 +--rw lora 105 +--rw channel-bandwidth? enumeration 106 +--rw coding-rate? enumeration 107 +--rw spreading-factor? uint8 108 +--rw physical-layer 109 | +--rw preamble-length? int32 110 | +--rw channel-frequency-range enumeration 111 | +--rw channel? uint8 112 | +--rw symbol-timeout? uint32 113 +--rw mac-layer 114 +--rw payload-encryption? boolean 115 +--rw delay? int32 116 +--rw fixed-length-payload? boolean 118 The data model defines a state container Mode which include the three 119 principal characteristics of the LoRA interface which determine the 120 parameters of the channel 122 Figure 1 124 3. LoRa YANG module 126 This model imports typedefs from [RFC6991]. 128 file "ietf-lora" 130 module ietf-lora { 131 namespace "urn:ietf:params:xml:ns:yang:ietf-lora"; 132 prefix lora; 134 organization "Acklio"; 136 contact "Ana Minaburo ana@minaburo.com"; 138 description 139 "This module contains a collection of YANG definitions for 140 configuring the LORA () network interface. 142 Copyright (c) 2015 IETF Trust and the persons identified as 143 authors of the code. All right reserved. 145 Redistribution and use in source binary forms, with or 146 without modification, is permitted pursuant to, and subject 147 to the license terms contained in, the Simplified BSD License 148 Relating to IETF Documents 149 (http://trustee.ietf.org/license-info) 151 This YANG module version is part of draft-minaburo-6lpwa-cosol-00; 152 see the draft itself for full legal notices."; 154 revision 2016-06-01 { 155 description "Initial Description"; 156 reference "LoRa MAC Class A Specification R3.1 by Semtech"; 157 } 159 grouping mode { 160 description " ToDO"; 161 leaf channel-bandwidth { 162 type enumeration { 163 enum 125 { value 0; description "125 KHz";} 164 enum 150 { value 1; description "150 KHz";} 165 enum 500 { value 2; description "500 KHz";} 166 } 167 description "Physical Channel Bandwidth"; 168 } 170 leaf coding-rate { 171 type enumeration { 172 enum 4_5 { value 1; description ""; } 173 enum 4_6 { value 2; description ""; } 174 enum 4_7 { value 3; description ""; } 175 enum 4_b { value 4; description ""; } 176 } 177 description "LORA error correction scheme"; 178 } 180 leaf spreading-factor { 181 type uint8 { 182 range "6 .. 12"; 183 } 184 description "Modulation to enable spread signals"; 186 } 188 } 190 container lora { 191 description "LORA channel"; 192 uses lora:mode; 193 container physical-layer { 194 description "LORA phisical layer"; 195 leaf preamble-length { 196 type int32; 197 default 7; 198 description "Header packet definition"; 199 } 201 leaf channel-frequency-range { 202 type enumeration { 203 enum europe { value 1; description "";} 204 enum usa { value 2; description "";} 205 enum japan { value 3; description "";} 206 enum china { value 4; description "";} 207 } 208 mandatory true; 209 description "Band Choice depends on Country"; 211 } 213 leaf channel { 214 type uint8 { 215 range "0..10"; 216 } 217 description "Physical Channels"; 218 } 220 leaf symbol-timeout { 221 type uint32; 222 description "Waiting the free band"; 223 } 224 } 226 container mac-layer { 227 description " LORA MAC layer format"; 228 leaf payload-encryption { 229 type boolean; 230 default "false"; 231 description "Known if the encryption is used"; 232 } 234 leaf delay { 235 type int32; 236 description "Delay value"; 237 } 239 leaf fixed-length-payload { 240 type boolean; 241 default "false"; 242 description "If Modulation is not variable"; 243 } 245 } 246 } 248 } 250 252 The data model defines a state container Mode which include the three 253 principal characteristics of the LoRA interface which determine the 254 parameters of the channel 256 Figure 2 258 4. Acknowledgements 260 We want to thank Alexander Pelov for all his inputs and corrections 261 to this work 263 5. IANA Considerations 265 This memo includes no request to IANA. 267 6. Security Considerations 269 All drafts are required to have a security considerations section. 270 See RFC 3552 [RFC3552] for a guide. TO DO 272 7. References 274 7.1. Normative References 276 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 277 Requirement Levels", BCP 14, RFC 2119, 278 DOI 10.17487/RFC2119, March 1997, 279 . 281 7.2. Informative References 283 [LoRa] Semtech, "https://web.archive.org/web/20150510011904/ 284 https://www.semtech.com/wireless-rf/lora.html", May 2015. 286 [RFC3552] Rescorla, E. and B. Korver, "Guidelines for Writing RFC 287 Text on Security Considerations", BCP 72, RFC 3552, 288 DOI 10.17487/RFC3552, July 2003, 289 . 291 Authors' Addresses 293 Ana Minaburo (editor) 294 Acklio 295 2bis rue de la Chataigneraie 296 Cesson-Sevigne, Bretagne 35510 297 FR 299 Email: ana@ackl.io 301 Laurent Toutain 302 Telecom Bretagne 303 2 Rue de la Chataigneraie 304 Cesson-Sevigne, Bretagne 35510 305 FR 307 Phone: +33299127026 308 Email: laurent.toutain@telecom-bretagne.eu 310 Yannick Delibie 311 Kerlink 312 1 rue Jacqueline Auriol 313 Thorigne-Fouillard, Bretagne 35235 314 FR 316 Phone: +33299122900 317 Email: yannick.delibie@kerlink.fr