idnits 2.17.1 draft-minaburo-yang-lora-00.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 111 has weird spacing: '...y Range enume...' == Line 115 has weird spacing: '...ryption boo...' == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document date (June 8, 2016) is 2872 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Missing Reference: 'RFC6991' is mentioned on line 127, but not defined Summary: 0 errors (**), 0 flaws (~~), 5 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, Ed. 5 Expires: December 10, 2016 Telecom Bretagne 6 Y. Delibie, Ed. 7 Kerlink 8 June 8, 2016 10 YANG module for LoRa Networks 11 draft-minaburo-yang-lora-00 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 10, 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 . . . . . . . . . . . . . . . . . . . . . . . . . 7 60 7.1. Normative References . . . . . . . . . . . . . . . . . . 7 61 7.2. Informative References . . . . . . . . . . . . . . . . . 7 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 +- RW ietf-lora 104 +- RW Lora 105 +- RW Mode 106 | +- RW Channel Bandwidth enumeration 107 | +- RW Coding Rate enumeration 108 | +- RW Spreading Factor int8 109 +- Physical Layer 110 | +- RW Preamblelength int32 111 | +- RW Channel Frequency Range enumeration 112 | +- RW Channel int8 113 | +- RW SymbolTimeout int32 114 +- MAC Layer 115 +- RW FrPayloadEncryption boolean 116 +- RW Delay int32 117 +- RW FixlengthPayloadOn boolean 119 The data model defines a state container Mode which include the three 120 principal characteristics of the LoRA interface which determine the 121 parameters of the channel 123 Figure 1 125 3. LoRa YANG module 127 This model imports typedefs from [RFC6991]. 129 module lora { 131 namespace "urn:lora"; 132 prefix lo; 134 import ietf-interfaces { 135 prefix if; 136 } 138 organization 139 "Acklio"; 141 contact 142 "Ana Minaburo 143 ana@minaburo.com"; 145 description 146 "This module contains a collection of YANG definitions for 147 configuring the LORA () network interface. 149 Copyright (c) 2015 IETF Trust and the persons identified as 150 authors of the code. All right reserved. 152 Redistribution and use in source binary forms, with or 153 without modification, is permitted pursuant to, and subject 154 to the license terms contained in, the Simplified BSD License 155 Relating to IETF Documents 156 (http://trustee.ietf.org/license-info) 158 This YANG module version is part of draft-minaburo-yang-lora-00; 159 see the draft itself for full legal notices."; 161 revision 2015-11-01 { 162 description 163 "Initial Description"; 164 reference 165 "LoRa MAC Class A Specification R3.1 by Semtech"; 166 } 168 grouping mode { 169 description "Principal factors to change modulation"; 170 leaf channel-bandwidth { 171 description "Physical Channel Bandwidth"; 172 type enumeration { 173 enum 125 { description "125 KHz"; value 0; } 174 enum 150 { description "150 KHz"; value 1; } 175 enum 500 { description "500 KHz"; value 2; } 176 } 177 } 179 leaf coding-rate { 180 description "LORA error correction scheme"; 181 type enumeration { 182 enum 4_5 { description "value 1; } 183 enum 4_6 { value 2; } 184 enum 4_7 { value 3; } 185 enum 4_b { value 4; } 186 } 187 } 189 leaf spreading-factor { 190 description "Modulation to enable spread signals to 191 transmit signals at the same time"; 192 type uint8 { 193 range "6 .. 12"; 194 } 195 } 197 } 199 augment "/if:interfaces/if:interface" { 200 description " // To be defined later"; 201 when "if:type = 'ianaieft:lora'"; 202 description "LORA channel"; 204 container lora { 205 uses mode; 206 container physical-layer { 207 description "LORA phisical layer"; 208 leaf preamble-length { 209 description "Header packet definition"; 210 type int32; 211 default 7; 212 } 214 leaf channel-frequency-range { 215 description "Band Choice depends on Country"; 216 type enumeration { 217 mandatory true; 218 enum europe; 219 enum usa; 220 enum japan; 221 enum china; 222 } 223 } 225 leaf channel { 226 description "Physical Channels"; 227 type uint8 { 228 range "0..10"; 229 } 230 } 232 leaf symbol-timeout { 233 description "Waiting the free band"; 234 type uint32; 235 } 236 } 238 container mac-layer { 239 description " LORA MAC layer format"; 240 leaf payload-encryption { 241 description "Known if the encryption is used"; 242 type boolean; 243 default "false"; 244 } 246 leaf delay { 247 description "Delay value"; 248 type int32; 249 } 251 leaf fixed-length-payload { 252 description "If Modulation is not variable"; 253 type boolean; 254 default "false"; 255 } 256 } 257 } 258 } 259 } 261 The data model defines a state container Mode which include the three 262 principal characteristics of the LoRA interface which determine the 263 parameters of the channel 265 Figure 2 267 4. Acknowledgements 269 We want to thank Alexander Pelov for all his inputs and corrections 270 on this work 272 5. IANA Considerations 274 This memo includes no request to IANA. 276 6. Security Considerations 278 All drafts are required to have a security considerations section. 279 See RFC 3552 [RFC3552] for a guide. TO DO 281 7. References 283 7.1. Normative References 285 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 286 Requirement Levels", BCP 14, RFC 2119, 287 DOI 10.17487/RFC2119, March 1997, 288 . 290 7.2. Informative References 292 [LoRa] Semtech, "https://web.archive.org/web/20150510011904/ 293 https://www.semtech.com/wireless-rf/lora.html", May 2015. 295 [RFC3552] Rescorla, E. and B. Korver, "Guidelines for Writing RFC 296 Text on Security Considerations", BCP 72, RFC 3552, 297 DOI 10.17487/RFC3552, July 2003, 298 . 300 Authors' Addresses 302 Ana Minaburo (editor) 303 Acklio 304 2bis rue de la Chataigneraie 305 Cesson-Sevigne, Bretagne 35510 306 FR 308 Email: ana@ackl.io 310 Laurent Toutain (editor) 311 Telecom Bretagne 312 2 Rue de la Chataigneraie 313 Cesson-Sevigne, Bretagne 35510 314 FR 316 Phone: +33299127026 317 Email: laurent.toutain@telecom-bretagne.eu 319 Yannick Delibie (editor) 320 Kerlink 321 1 rue Jacqueline Auriol 322 Thorigne-Fouillard, Bretagne 35235 323 FR 325 Phone: +33299122900 326 Email: yannick.delibie@kerlink.fr