idnits 2.17.1 draft-pelov-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 == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document date (March 2, 2016) is 2970 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Missing Reference: 'RFC6991' is mentioned on line 129, but not defined Summary: 0 errors (**), 0 flaws (~~), 3 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force A. Pelov, Ed. 3 Internet-Draft Acklio 4 Intended status: Informational L. Toutain, Ed. 5 Expires: September 3, 2016 Institut MINES-TELECOM ; Telecom Bretagne 6 Y. Delibie, Ed. 7 Kerlink 8 A. Minaburo, Ed. 9 Acklio 10 March 2, 2016 12 YANG module for LoRa Networks 13 draft-pelov-yang-lora-01 15 Abstract 17 This document presents a YANG module definition for managing LoRa- 18 based devices. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at http://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on September 3, 2016. 37 Copyright Notice 39 Copyright (c) 2016 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents 44 (http://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 55 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3 56 2. LoRa Data Model . . . . . . . . . . . . . . . . . . . . . . . 3 57 3. LoRa YANG module . . . . . . . . . . . . . . . . . . . . . . 3 58 4. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6 59 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 60 6. Security Considerations . . . . . . . . . . . . . . . . . . . 6 61 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 62 7.1. Normative References . . . . . . . . . . . . . . . . . . 6 63 7.2. Informative References . . . . . . . . . . . . . . . . . 7 64 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 66 1. Introduction 68 This document provides a YANG module description for managing a LoRa 69 endpoints. 71 SemTech [LoRa] (c) is a low-rate, low-power, long-range radio 72 technology. It could be used as a base radio technology for building 73 Low-Rate Wide-Area Networks (LR-WAN), also known as LPWA (Low-Power 74 Wide Area). SemTech [LoRa] (c) has the following characteristics: 76 o Works in narrow, license-free (ISM) bands with good propagation 77 properties (< 1GHz) 79 o Low- to very-low throughput (270 bps--200 kbps) 81 o Low-power operation (25 mW in Europe) 83 o Far-Reaching communication capabilities (20 km with line-of-sight, 84 several km in urban environment) 86 o Strong channel access restrictions (1% to 10% duty cycling) 88 The management of LoRa-based devices can be done through a standard 89 approach, compatible with the best network-operator practices, namely 90 NETCONF or RESTCONF. A formal definition of the parameters and the 91 values to be managed is thus required, which can be done with the 92 YANG module language. The following document presents a YANG module 93 definition for managing a LoRa-based end-device. 95 1.1. Requirements Language 97 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 98 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 99 document are to be interpreted as described in RFC 2119 [RFC2119]. 101 2. LoRa Data Model 103 The data model has the following structure for Lora configuration: 105 +- RW lora 106 +- RW Lora Device 107 +- RW Mode 108 | +- RW Channel Bandwidth enumeration 109 | +- RW Coding Rate enumeration 110 | +- RW Spreading Factor int8 111 +- Physical Layer 112 | +- RW Preamblelength int32 113 | +- RW Channel Frequency Range enumeration 114 | +- RW Channel int8 115 | +- RW SymbolTimeout int32 116 +- MAC Layer 117 +- RW FrPayloadEncryption boolean 118 +- RW Delay int32 119 +- RW FixlengthPayloadOn boolean 121 The data model defines a state container Mode which includes the 122 three principal characteristics of the LoRA interface which determine 123 the parameters of the channel 125 Figure 1 127 3. LoRa YANG module 129 This model imports typedefs from [RFC6991]. 131 file "ietf-pelov@2015-10-10.yang" 133 module lora { 135 namespace "urn:lora"; 136 prefix lo; 138 import ietf-interfaces { 139 prefix if; 141 } 143 organization 144 "Acklio"; 146 contact 147 "Alexander Pelov 148 a@ackl.io"; 149 "Ana Minaburo 150 ana@minaburo.com"; 152 description 153 "This module contains a collection of YANG definitions for 154 configuring the LORA () network interface. 156 Copyright (c) 2015 IETF Trust and the persons identified as 157 authors of the code. All right reserved. 159 Redistribution and use in source binary forms, with or 160 without modification, is permitted pursuant to, and subject 161 to the license terms contained in, the Simplified BSD License 162 Relating to IETF Documents 163 (http://trustee.ietf.org/license-info) 165 169 revision 2015-11-01 { 170 description 171 "Initial Description"; 172 reference 173 "LoRa MAC Class A Specification R3.1 by Semtech"; 174 } 176 grouping mode { 177 leaf channel-bandwidth { 178 type enumeration { 179 enum 125 { value 0; } 180 enum 150 { value 1; } 181 enum 500 { value 2; } 182 } 183 } 185 leaf coding-rate { 186 type enumeration { 187 enum 4_5 { value 1; } 188 enum 4_6 { value 2; } 189 enum 4_7 { value 3; } 190 enum 4_b { value 4; } 191 } 192 } 194 leaf spreading-factor { 195 type uint8 { 196 range "6 .. 12"; 197 } 198 } 200 } 202 augment "/if:interfaces/if:interface" { 203 // To be defined later 204 when "if:type = 'ianaift:lora'"; 206 container lora { 207 uses mode; 208 container physical-layer { 209 leaf preamble-length { 210 type int32; 211 default 7; 212 } 214 leaf channel-frequency-range { 215 mandatory true; 216 type enumeration { 217 enum europe; 218 enum usa; 219 enum japan; 220 enum china; 221 } 222 } 224 leaf channel { 225 type uint8 { 226 range "0..10"; 227 } 228 } 230 leaf symbol-timeout { 231 type uint32; 232 } 233 } 235 container mac-layer { 236 leaf payload-encryption { 237 type boolean; 238 default "false"; 239 } 241 leaf delay { 242 type int32; 243 } 245 leaf fixed-length-payload { 246 type boolean; 247 default "false"; 248 } 249 } 250 } 251 } 252 } 254 256 The data model defines a state container Mode which include the three 257 principal characteristics of the LoRA interface which determine the 258 parameters of the channel 260 Figure 2 262 4. Acknowledgements 264 5. IANA Considerations 266 This memo includes no request to IANA. 268 6. Security Considerations 270 All drafts are required to have a security considerations section. 271 See RFC 3552 [RFC3552] for a guide. TO DO 273 7. References 275 7.1. Normative References 277 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 278 Requirement Levels", BCP 14, RFC 2119, 279 DOI 10.17487/RFC2119, March 1997, 280 . 282 7.2. Informative References 284 [LoRa] Semtech, "https://web.archive.org/web/20150510011904/ 285 https://www.semtech.com/wireless-rf/lora.html", May 2015. 287 [RFC3552] Rescorla, E. and B. Korver, "Guidelines for Writing RFC 288 Text on Security Considerations", BCP 72, RFC 3552, 289 DOI 10.17487/RFC3552, July 2003, 290 . 292 Authors' Addresses 294 Alexander Pelov (editor) 295 Acklio 296 2bis Rue de la Chataigneraie 297 Cesson-Sevigne, Bretagne 35510 298 FR 300 Phone: +33299127004 301 Email: a@ackl.io 303 Laurent Toutain (editor) 304 Institut MINES-TELECOM ; Telecom Bretagne 305 2bis Rue de la Chataigneraie 306 Cesson-Sevigne, Bretagne 35510 307 FR 309 Phone: +33299127026 310 Email: laurent.toutain@telecom-bretagne.eu 312 Yannick Delibie (editor) 313 Kerlink 314 1 rue Jacqueline Auriol 315 Thorigne-Fouillard, Bretagne 35235 316 FR 318 Phone: +33299122900 319 Email: yannick.delibie@kerlink.fr 320 Ana Minaburo (editor) 321 Acklio 322 2bis rue de la Chataigneraie 323 Cesson-Sevigne, Bretagne 35510 324 FR 326 Phone: +33672461470 327 Email: ana@ackl.io