YANG module for LoRa Networks
draft-pelov-yang-lora-00

Abstract

This document presents a YANG module definition for managing LoRa-based devices.

Status of This Memo

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 June 18, 2016.

Copyright Notice

Copyright (c) 2015 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.

Table of Contents

• 1. Introduction
• 1.1. Requirements Language
• 2. LoRa Data Model
• 3. LoRa YANG module
• 4. Acknowledgements
• 5. IANA Considerations
• 6. Security Considerations
• 7. References
• 7.1. Normative References
• 7.2. Informative References
• Authors' Addresses

1. Introduction

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:

• Works in narrow, license-free (ISM) bands with good propagation properties (< 1GHz)
• Low- to very-low throughput (270 bps--200 kbps)
• Low-power operation (25 mW in Europe)
• Far-Reaching communication capabilities (20 km with line-of-sight, several km in urban environment)
• Strong channel access restrictions (1% to 10% duty cycling)

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.

1.1. Requirements Language

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].

2. LoRa Data Model

The data model has the following structure for Lora configuration:

+- RW lora
    +- RW Lora Device
       +- RW Mode
       |   +- RW Channel Bandwidth      enumeration		
       |   +- RW Coding Rate            enumeration
       |   +- RW Spreading Factor       int8
       +- Physical Layer
       |   +- RW Preamblelength         int32
       |   +- RW Channel Frequency Range  enumeration
       |   +- RW Channel                int8
       |   +- RW SymbolTimeout          int32
       +- MAC Layer
      	   +- RW FrPayloadEncryption    boolean
      	   +- RW Delay                  int32    
           +- RW FixlengthPayloadOn     boolean
          
            

<CODE BEGINS> file "ietf-pelov@2015-10-10.yang"

module lora {

    namespace "urn:lora";
    prefix lo;


	import ietf-interfaces {
       prefix if;
	}

    organization
      "Acklio";

    contact
      "Alexander Pelov
     a@ackl.io";
    "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 version of this YANG module is part of draft-pelov-yang-lora-00; see 
   the draft itself for full legal notices.";

    revision 2015-11-01 {
      description
        "Initial Description";
      reference
        "LoRa MAC Class A Specification R3.1 by Semtech";
    }


    grouping mode {
    	leaf channel-bandwidth {
    		type enumeration {
    			enum 125 { value 0; }
    			enum 150 { value 1; }
    			enum 500 { value 2; }
    		}
    	}

    	leaf coding-rate {
    		type enumeration {
    			enum 4_5 { value 1; }
    			enum 4_6 { value 2; }
    			enum 4_7 { value 3; }
    			enum 4_b { value 4; }			
    		}
    	}

    	leaf spreading-factor {
    		type uint8 {
    			range "6 .. 12";
    		}
    	}

    }

    augment "/if:interfaces/if:interface" {
    	// To be defined later
    	when "if:type = 'ianaift:lora'";

    	container lora {
    		uses mode;
	    	container physical-layer {
	    		leaf preamble-length {
	    			type int32;
					default 7;
	    		}

	    		leaf channel-frequency-range {
	    			mandatory true;
	    			type enumeration {
	    				enum europe;
	    				enum usa;
	    				enum japan;
	    				enum china;
	    			}
	    		}

	    		leaf channel {
	    			type uint8 {
	    				range "0..10";
	    			}
	    		}

	    		leaf symbol-timeout {
	    			type uint32;
	    		}
    		}

    		container mac-layer {
    			leaf payload-encryption {
    				type boolean;
    				default "false";
    			}

    			leaf delay {
    				type int32;
    			}

    			leaf fixed-length-payload {
    				type boolean;
    				default "false";
    			}
	    	}
    	}
    }
}

<CODE ENDS>