| < draft-minaburo-6lpwa-yang-lora-00.txt | draft-minaburo-6lpwa-yang-lora-01.txt > | |||
|---|---|---|---|---|
| Internet Engineering Task Force A. Minaburo, Ed. | Internet Engineering Task Force A. Minaburo, Ed. | |||
| Internet-Draft Acklio | Internet-Draft Acklio | |||
| Intended status: Informational L. Toutain | Intended status: Informational L. Toutain | |||
| Expires: December 17, 2016 Telecom Bretagne | Expires: December 17, 2016 Telecom Bretagne | |||
| Y. Delibie | Y. Delibie | |||
| Kerlink | Kerlink | |||
| June 15, 2016 | June 15, 2016 | |||
| YANG module for LoRa Networks | YANG module for LoRa Networks | |||
| draft-minaburo-6lpwa-yang-lora-00 | draft-minaburo-6lpwa-yang-lora-01 | |||
| Abstract | Abstract | |||
| This document presents a YANG module definition for managing LoRa- | This document presents a YANG module definition for managing LoRa- | |||
| based devices. | based devices. | |||
| Status of This Memo | Status of This Memo | |||
| This Internet-Draft is submitted in full conformance with the | This Internet-Draft is submitted in full conformance with the | |||
| provisions of BCP 78 and BCP 79. | provisions of BCP 78 and BCP 79. | |||
| skipping to change at page 2, line 14 ¶ | skipping to change at page 2, line 14 ¶ | |||
| Table of Contents | Table of Contents | |||
| 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 | 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 | |||
| 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 | 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 | |||
| 2. LoRa Data Model . . . . . . . . . . . . . . . . . . . . . . . 3 | 2. LoRa Data Model . . . . . . . . . . . . . . . . . . . . . . . 3 | |||
| 3. LoRa YANG module . . . . . . . . . . . . . . . . . . . . . . 3 | 3. LoRa YANG module . . . . . . . . . . . . . . . . . . . . . . 3 | |||
| 4. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6 | 4. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6 | |||
| 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 | 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 | |||
| 6. Security Considerations . . . . . . . . . . . . . . . . . . . 6 | 6. Security Considerations . . . . . . . . . . . . . . . . . . . 6 | |||
| 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 | 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 | |||
| 7.1. Normative References . . . . . . . . . . . . . . . . . . 7 | 7.1. Normative References . . . . . . . . . . . . . . . . . . 6 | |||
| 7.2. Informative References . . . . . . . . . . . . . . . . . 7 | 7.2. Informative References . . . . . . . . . . . . . . . . . 6 | |||
| Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 | Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 | |||
| 1. Introduction | 1. Introduction | |||
| This document provides a YANG module description for managing a LoRa | This document provides a YANG module description for managing a LoRa | |||
| endpoints. | endpoints. | |||
| SemTech [LoRa] (c) is a low-rate, low-power, long-range radio | SemTech [LoRa] (c) is a low-rate, low-power, long-range radio | |||
| technology. It could be used as a base radio technology for building | 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 | Low-Rate Wide-Area Networks (LR-WAN), also known as LPWA (Low-Power | |||
| skipping to change at page 3, line 9 ¶ | skipping to change at page 3, line 9 ¶ | |||
| 1.1. Requirements Language | 1.1. Requirements Language | |||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | |||
| "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this | "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this | |||
| document are to be interpreted as described in RFC 2119 [RFC2119]. | document are to be interpreted as described in RFC 2119 [RFC2119]. | |||
| 2. LoRa Data Model | 2. LoRa Data Model | |||
| The data model has the following structure for Lora configuration: | The data model has the following structure for Lora configuration: | |||
| +- RW ietf-lora | module: ietf-lora | |||
| +- RW Lora | +--rw lora | |||
| +- RW Mode | +--rw channel-bandwidth? enumeration | |||
| | +- RW Channel Bandwidth enumeration | +--rw coding-rate? enumeration | |||
| | +- RW Coding Rate enumeration | +--rw spreading-factor? uint8 | |||
| | +- RW Spreading Factor int8 | +--rw physical-layer | |||
| +- Physical Layer | | +--rw preamble-length? int32 | |||
| | +- RW Preamblelength int32 | | +--rw channel-frequency-range enumeration | |||
| | +- RW Channel Frequency Range enumeration | | +--rw channel? uint8 | |||
| | +- RW Channel int8 | | +--rw symbol-timeout? uint32 | |||
| | +- RW SymbolTimeout int32 | +--rw mac-layer | |||
| +- MAC Layer | +--rw payload-encryption? boolean | |||
| +- RW FrPayloadEncryption boolean | +--rw delay? int32 | |||
| +- RW Delay int32 | +--rw fixed-length-payload? boolean | |||
| +- RW FixlengthPayloadOn boolean | ||||
| The data model defines a state container Mode which include the three | The data model defines a state container Mode which include the three | |||
| principal characteristics of the LoRA interface which determine the | principal characteristics of the LoRA interface which determine the | |||
| parameters of the channel | parameters of the channel | |||
| Figure 1 | Figure 1 | |||
| 3. LoRa YANG module | 3. LoRa YANG module | |||
| This model imports typedefs from [RFC6991]. | This model imports typedefs from [RFC6991]. | |||
| module lora { | <CODE BEGINS> file "ietf-lora" | |||
| namespace "urn:lora"; | module ietf-lora { | |||
| namespace "urn:ietf:params:xml:ns:yang:ietf-lora"; | ||||
| prefix lora; | prefix lora; | |||
| import ietf-interfaces { | organization "Acklio"; | |||
| prefix if; | ||||
| } | ||||
| organization | ||||
| "Acklio"; | ||||
| contact | contact "Ana Minaburo ana@minaburo.com"; | |||
| "Ana Minaburo | ||||
| ana@minaburo.com"; | ||||
| description | description | |||
| "This module contains a collection of YANG definitions for | "This module contains a collection of YANG definitions for | |||
| configuring the LORA () network interface. | configuring the LORA () network interface. | |||
| Copyright (c) 2015 IETF Trust and the persons identified as | Copyright (c) 2015 IETF Trust and the persons identified as | |||
| authors of the code. All right reserved. | authors of the code. All right reserved. | |||
| Redistribution and use in source binary forms, with or | Redistribution and use in source binary forms, with or | |||
| without modification, is permitted pursuant to, and subject | without modification, is permitted pursuant to, and subject | |||
| to the license terms contained in, the Simplified BSD License | to the license terms contained in, the Simplified BSD License | |||
| Relating to IETF Documents | Relating to IETF Documents | |||
| (http://trustee.ietf.org/license-info) | (http://trustee.ietf.org/license-info) | |||
| This YANG module version is part of draft-minaburo-yang-lora-00; | This YANG module version is part of draft-minaburo-6lpwa-cosol-00; | |||
| see the draft itself for full legal notices."; | see the draft itself for full legal notices."; | |||
| revision 2015-11-01 { | revision 2016-06-01 { | |||
| description | description "Initial Description"; | |||
| "Initial Description"; | reference "LoRa MAC Class A Specification R3.1 by Semtech"; | |||
| reference | ||||
| "LoRa MAC Class A Specification R3.1 by Semtech"; | ||||
| } | } | |||
| grouping mode { | grouping mode { | |||
| description "Principal factors to change modulation"; | description " ToDO"; | |||
| leaf channel-bandwidth { | leaf channel-bandwidth { | |||
| description "Physical Channel Bandwidth"; | ||||
| type enumeration { | type enumeration { | |||
| enum 125 { description "125 KHz"; value 0; } | enum 125 { value 0; description "125 KHz";} | |||
| enum 150 { description "150 KHz"; value 1; } | enum 150 { value 1; description "150 KHz";} | |||
| enum 500 { description "500 KHz"; value 2; } | enum 500 { value 2; description "500 KHz";} | |||
| } | } | |||
| description "Physical Channel Bandwidth"; | ||||
| } | } | |||
| leaf coding-rate { | leaf coding-rate { | |||
| description "LORA error correction scheme"; | ||||
| type enumeration { | type enumeration { | |||
| enum 4_5 { description "value 1; } | enum 4_5 { value 1; description ""; } | |||
| enum 4_6 { value 2; } | enum 4_6 { value 2; description ""; } | |||
| enum 4_7 { value 3; } | enum 4_7 { value 3; description ""; } | |||
| enum 4_b { value 4; } | enum 4_b { value 4; description ""; } | |||
| } | } | |||
| description "LORA error correction scheme"; | ||||
| } | } | |||
| leaf spreading-factor { | leaf spreading-factor { | |||
| description "Modulation to enable spread signals to | type uint8 { | |||
| transmit signals at the same time"; | range "6 .. 12"; | |||
| type uint8 { | } | |||
| range "6 .. 12"; | description "Modulation to enable spread signals"; | |||
| } | ||||
| } | ||||
| } | } | |||
| augment "/if:interfaces/if:interface" { | } | |||
| description " // To be defined later"; | ||||
| when "if:type = 'ianaieft:lora'"; | ||||
| description "LORA channel"; | ||||
| container lora { | container lora { | |||
| uses mode; | description "LORA channel"; | |||
| uses lora:mode; | ||||
| container physical-layer { | container physical-layer { | |||
| description "LORA phisical layer"; | description "LORA phisical layer"; | |||
| leaf preamble-length { | leaf preamble-length { | |||
| description "Header packet definition"; | ||||
| type int32; | type int32; | |||
| default 7; | default 7; | |||
| description "Header packet definition"; | ||||
| } | } | |||
| leaf channel-frequency-range { | leaf channel-frequency-range { | |||
| description "Band Choice depends on Country"; | ||||
| type enumeration { | type enumeration { | |||
| mandatory true; | enum europe { value 1; description "";} | |||
| enum europe; | enum usa { value 2; description "";} | |||
| enum usa; | enum japan { value 3; description "";} | |||
| enum japan; | enum china { value 4; description "";} | |||
| enum china; | ||||
| } | } | |||
| mandatory true; | ||||
| description "Band Choice depends on Country"; | ||||
| } | } | |||
| leaf channel { | leaf channel { | |||
| description "Physical Channels"; | ||||
| type uint8 { | type uint8 { | |||
| range "0..10"; | range "0..10"; | |||
| } | } | |||
| description "Physical Channels"; | ||||
| } | } | |||
| leaf symbol-timeout { | leaf symbol-timeout { | |||
| description "Waiting the free band"; | ||||
| type uint32; | type uint32; | |||
| description "Waiting the free band"; | ||||
| } | } | |||
| } | } | |||
| container mac-layer { | container mac-layer { | |||
| description " LORA MAC layer format"; | description " LORA MAC layer format"; | |||
| leaf payload-encryption { | leaf payload-encryption { | |||
| description "Known if the encryption is used"; | ||||
| type boolean; | type boolean; | |||
| default "false"; | default "false"; | |||
| description "Known if the encryption is used"; | ||||
| } | } | |||
| leaf delay { | leaf delay { | |||
| description "Delay value"; | ||||
| type int32; | type int32; | |||
| description "Delay value"; | ||||
| } | } | |||
| leaf fixed-length-payload { | leaf fixed-length-payload { | |||
| description "If Modulation is not variable"; | ||||
| type boolean; | type boolean; | |||
| default "false"; | default "false"; | |||
| description "If Modulation is not variable"; | ||||
| } | } | |||
| } | } | |||
| } | } | |||
| } | ||||
| } | } | |||
| <CODE ENDS> | ||||
| The data model defines a state container Mode which include the three | The data model defines a state container Mode which include the three | |||
| principal characteristics of the LoRA interface which determine the | principal characteristics of the LoRA interface which determine the | |||
| parameters of the channel | parameters of the channel | |||
| Figure 2 | Figure 2 | |||
| 4. Acknowledgements | 4. Acknowledgements | |||
| We want to thank Alexander Pelov for all his inputs and corrections | We want to thank Alexander Pelov for all his inputs and corrections | |||
| to this work | to this work | |||
| End of changes. 37 change blocks. | ||||
| 70 lines changed or deleted | 61 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/ | ||||