nRF24-ruby 0.0.1

data/examples/nRF24-demo.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+#encoding: UTF-8
+
+if File.file? './lib/nRF24-ruby.rb'
+  require './lib/nRF24-ruby.rb'
+  puts "using local lib"
+else
+  require 'nRF24-ruby'
+end
+
+puts "\nPure Ruby nRF24L01 Driver Starting..."
+
+http=true
+
+if http
+  puts "Loading Http-server.. hold on.."
+  require 'minimal-http-ruby'
+  minimal_http_server http_port: 8088, http_path: "./http/"
+  puts "\n"
+end
+
+
+r0=NRF24.new id: :eka, ce: 22,cs: 27, irq: 17, chan:3, ack: true
+r1=NRF24.new id: :toka, ce: 24,cs: 23, irq: 22, chan: 3, ack: true
+
+puts "Main Loop Starts:"
+
+loopc=0;
+sc=0;
+
+loop do
+  if (loopc%4)==0
+    msg=[]
+    str=sprintf "testing %5.5d -- testing?",sc%10000
+    sc+=1
+    str.each_byte do |b|
+      msg<<b
+    end
+     if sc&1==0
+      r0.send_q << msg
+    else
+      r1.send_q << msg
+    end
+    NRF24::note "sent '#{str}' to #{sc&1}"
+  end
+  loopc+=1
+  while not r1.recv_q.empty?
+    got=r1.recv_q.pop
+    #puts "got 1 #{got}"
+    msg=""
+    len=0
+    got.each_with_index do |b,i|
+      msg[i]=b.chr
+    end
+    NRF24::note "got #{msg} from 1!"
+  end
+  while not r0.recv_q.empty?
+    got=r0.recv_q.pop
+    #puts "got 0 #{got}"
+    msg=""
+    len=0
+    got.each_with_index do |b,i|
+      msg[i]=b.chr
+    end
+    NRF24::note "got #{msg} from 0!"
+  end
+  if not http
+    pp r0.json
+    pp r1.json
+  end
+  sleep 0.1
+end
+

data/http/coffee/nRF24.coffee

@@ -0,0 +1,118 @@
+regs={}
+stat_vars= ['rcnt','rfull','scnt','sarc','sfail']
+logger = (data) ->
+  #console.log "log>",data
+  if data.event==0
+    $(".log").html("alku\n")
+  for l in data.loglines
+    #console.log l
+    $(".log").prepend(l.text+"\n")  
+
+
+dev = (d,obj) ->
+  #ret+="<td>#{obj.scnt}<td>"
+  for k in stat_vars
+      $("#d#{d}r#{k}").html obj[k]
+  for k,v of obj.regs
+    if (v instanceof Array)
+      str=""
+      for a in v
+        str+=((0x100+a).toString(16).substring(1,3).toUpperCase())
+      $("#d#{d}r#{k}").html str
+    else
+      if regs[k].format =="hex"
+        $("#d#{d}r#{k}").html "0x"+((0x100+v).toString(16).substring(1,3).toUpperCase())
+      else if regs[k].format =="dec"
+        $("#d#{d}r#{k}").html (v).toString(10)
+      else
+        if regs[k].len
+          $("#d#{d}r#{k}").html (0x100+v).toString(2).substring(1+8-regs[k].len,9)
+        else
+          $("#d#{d}r#{k}").html (0x100+v).toString(2).substring(1,9)
+
+update_status = (data) ->
+  #console.log data
+  $(".info").html(data.now)
+  dev(0,data.devs[0])
+  dev(1,data.devs[1])
+
+@build_regs = (regs) ->
+  ret="<table>"
+  for k,v of regs
+    ret+="<tr>"
+    ret+="<td >#{v.name}<td>"
+    ret+="<td id='d0r#{k}'>d0r#{k}<td>"
+    ret+="<td id='d1r#{k}'>d1r#{k}<td>"
+    ret+="</tr>"
+  ret+="</table>"
+  $(".regs").html(ret)
+  ret="<table>"
+  for k in stat_vars
+    ret+="<tr>"
+    ret+="<td >#{k}<td>"
+    ret+="<td id='d0r#{k}'>d0r#{k}<td>"
+    ret+="<td id='d1r#{k}'>d1r#{k}<td>"
+    ret+="</tr>"
+  ret+="</table>"
+  $(".stats").html(ret)
+
+@process_data = (obj) ->
+  #console.log "process",obj,obj.type
+  if obj.type == "register_table"
+    raw_regs=[]
+    for k,v of  obj.data
+      regs[v.address]=v
+      regs[v.address].name=k
+    console.log regs
+  build_regs regs
+  
+@ajaxform = (obj) ->
+  console.log "doin ajaxform"
+  form=$(obj).closest("form")
+  key=form.attr('id')
+  q=$( form ).serialize()
+  console.log q
+  $.ajax
+    url: "/action.json?#{q}"
+    type: "GET"
+    processData: false
+    contentType: false
+    success: (data) ->
+      console.log "ajax returns: ", data
+      
+      return
+    error: (xhr, ajaxOptions, thrownError) ->
+      alert thrownError
+      return
+
+@ajax = (url,obj) ->
+  console.log "doin ajax"
+  $.ajax
+    url: url
+    type: "GET"
+    processData: false
+    contentType: false
+    success: (data) ->
+      console.log "ajax returns: ", data
+      process_data(data)
+      return
+    error: (xhr, ajaxOptions, thrownError) ->
+      alert thrownError
+      return
+
+$ ->
+  console.log "nRF24 Starts"
+  #update_gw()
+  #setInterval(->
+  #  update_gw()
+  #  return
+  #, 200000)
+  ajax("/init.json",[])
+  stream = new EventSource("/nRF24.json")
+  stream.addEventListener "message", (event) ->
+    update_status($.parseJSON(event.data))
+    return
+  stream = new EventSource("/logger.json")
+  stream.addEventListener "message", (event) ->
+    logger($.parseJSON(event.data))
+    return

data/http/css/nRF24.css

@@ -0,0 +1,14 @@
+table.vt, th.vt, td.vt {
+   text-align: right;
+   font-size: 100%;
+   font-family: 'VT323' ;
+   color: #80ff80;
+   background-color: black;
+   vertical-align: top;
+}
+
+.log {
+    height: 400px;
+    width: 100%;
+    overflow: scroll;
+}

data/http/haml/index.haml

@@ -0,0 +1,50 @@
+!!!
+%html{lang: "fi"}
+  %head
+    %title nRF24 Pure Ruby Driver 
+    %meta{:charset => "utf-8"}/
+    %link{:href => "/css/nRF24.css", :rel => "stylesheet", :type => "text/css"}
+    %link{:href => "http://fonts.googleapis.com/css?family=VT323", :rel => "stylesheet", :type => "text/css"}
+    %script{:src => "https://code.jquery.com/jquery-2.1.1.min.js"}
+    %script{:src => "/nRF24.js"}
+  %body
+    %h1 nRF24 Pure Ruby Driver 
+    %p.info ?
+    %form{ onsubmit: "ajaxform(this); return(false);"}
+      Channel:
+      %input{name: "chan", size: 10}
+      Rf_Dr:
+      %select{name: "rf_dr"}
+        %option{value: "1"} 2Mbps
+        %option{value: "0"} 1Mbps
+      Rf_Pwr:
+      %select{name: "rf_pwr"}
+        %option{value: "0"} -18dBm
+        %option{value: "1"} -12dBm
+        %option{value: "2"} -6dBm
+        %option{value: "3"} 0dBm
+      Lna_gain:
+      %select{name: "lna_hcurr"}
+        %option{value: "1"} Normal
+        %option{value: "0"} Low
+      Auto_Ack:
+      %input{type: :checkbox,name: "aa", value: "true"}
+      %button{value: "Exec", onclick: "ajaxform(this); return(false);"}
+        ReConfig&Reset
+    %hr
+    %table
+      %tr
+        %td{width: "20%"}
+          %table.vt
+            %tr
+              %td.regs 
+              %td.stats
+        %td{width: "80%"}
+          %pre.log 
+    %hr
+    %p
+      %font{size: "-1"}
+        Written by
+        %a{href: "mailto:jalopuuverstas@gmail.com"}
+          Ari Siitonen 
+        2014 

data/http/haml/index.html

@@ -0,0 +1 @@
+Okei

data/http/json/action.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# encode: UTF-8
+
+def json_action request,args,session,event
+  pp args
+  devs=NRF24::all_devices
+  chan=(args['chan']||2).to_i
+  chan&=0x7f
+  if args['aa']=="true"
+    aa=true
+  else
+    aa=nil
+  end
+
+  devs.each do |d|
+  	if false
+	  	d.wreg :RF_CH,chan
+	  	d.cmd :FLUSH_TX
+	    d.cmd :FLUSH_RX
+	    d.get_regs true
+	  else
+	  	puts "initing #{d}"
+	  	d.hw_init chan: chan, ack: aa, rf_dr: args['rf_dr'], rf_pwr: args['rf_pwr'], lna_hcurr: args['lna_hcurr']
+	  	d.get_regs true
+	  end
+  end
+  data={jee: 123}
+  return ["text/json",data]
+end

data/http/json/init.rb

@@ -0,0 +1,6 @@
+# encode: UTF-8
+
+def json_init request,args,session,event
+  data={type: :register_table, data: NRF24::register_table }
+  return ["application/json",data]
+end

data/http/json/logger.rb

@@ -0,0 +1,25 @@
+# encode: UTF-8
+
+def json_logger request,args,session,event
+  if not session or session==0
+    return ["text/event-stream",{}]
+  end
+  @http_sessions[session][:log_pos]=0 if not @http_sessions[session][:log_pos]
+  size=NRF24::get_log.size
+  if @http_sessions[session][:log_pos]!=size
+    if size-@http_sessions[session][:log_pos]>30
+      @http_sessions[session][:log_pos]=size-30
+    end
+    loglines=NRF24::get_log[@http_sessions[session][:log_pos],size-@http_sessions[session][:log_pos]]
+    @http_sessions[session][:log_pos]=size
+  else
+    loglines=[]
+  end
+
+  data={
+  	loglines: loglines,
+  	session: session,
+  	event: event,
+  	}
+  return ["text/event-stream",data]
+end

data/http/json/nRF24.rb

@@ -0,0 +1,10 @@
+# encode: UTF-8
+
+def json_nRF24 request,args,session,event
+  if not session or session==0
+    return ["text/event-stream",{}]
+  end
+  #sleep 3
+  data=NRF24::json
+  return ["text/event-stream",data]
+end

data/lib/nRF24-ruby.rb

@@ -0,0 +1,357 @@
+#!/usr/bin/env ruby
+#encoding: UTF-8
+
+require 'pp'
+require 'thread'
+require 'pi_piper'
+include PiPiper
+
+class NRF24
+  @@all=[]
+  @@PAYLOAD_SIZE=32
+  @@SPI_CLOCK=250000
+        
+  @@regs={
+    CONFIG:      {address: 0x00,len:7},
+    EN_AA:       {address: 0x01,len:5},
+    EN_RXADDR:   {address: 0x02,len:5},
+    SETUP_AW:    {address: 0x03},
+    SETUP_RETR:  {address: 0x04},
+    RF_CH:       {address: 0x05,format: :dec},
+    RF_SETUP:    {address: 0x06,len:4},
+    STATUS:      {address: 0x07, poll: 1,len: 7},
+    OBSERVE_TX:  {address: 0x08, poll: 1},
+    CD:          {address: 0x09, poll: 1, len: 1},
+    RX_ADDR_P0:  {address: 0x0A, bytes: 5, format: :hex },
+    RX_ADDR_P1:  {address: 0x0B, bytes: 5, format: :hex },
+    RX_ADDR_P2:  {address: 0x0C, format: :hex},
+    RX_ADDR_P3:  {address: 0x0D, format: :hex},
+    RX_ADDR_P4:  {address: 0x0E, format: :hex},
+    RX_ADDR_P5:  {address: 0x0F, format: :hex},
+    TX_ADDR:     {address: 0x10, bytes: 5 , format: :hex},
+    RX_PW_P0:    {address: 0x11, format: :dec},
+    RX_PW_P1:    {address: 0x12, format: :dec},
+    FIFO_STATUS: {address: 0x17, poll: 1, len:7},
+    DYNPD:       {address: 0x1C,len:5},
+    FEATURE:     {address: 0x1D,len:3},
+  }
+
+  @@cmds={
+    R_REGISTER: 0x00,
+    W_REGISTER: 0x20,
+    ACTIVATE:   0x50,
+    R_RX_PL_WID: 0x60,
+    R_RX_PAYLOAD: 0x61,
+    W_TX_PAYLOAD: 0xA0,
+    FLUSH_TX:   0xe1,
+    FLUSH_RX:   0xe2,
+    W_TX_PAYLOAD_NOACK: 0xB0,
+    ACTIVATE2:  0x73,
+  }
+
+  @@sem=Mutex.new 
+  @@log=[]
+
+  def self.note str,*args
+    begin
+      s=sprintf(str,*args)
+      text=sprintf("%s: %s",Time.now.iso8601,s)
+      @@log << {stamp: Time.now.to_i, text: text.encode("UTF-8", :invalid=>:replace, :replace=>"?")}
+    rescue => e
+      pp e.backtrace
+      puts "note dies: #{e} '#{str}'"
+    end
+  end
+  
+  def get_ccode c
+    ccode=@@cmds[c]
+    if not ccode
+      printf("Error: Unkown Command %s\n",c);
+      raise "Command Error"
+    end
+    ccode
+  end
+
+  def get_address reg
+    rdata=@@regs[reg]
+    if not rdata
+      raise "Unknown Register : #{reg}"
+    end
+    [rdata[:address],rdata[:bytes]||1]
+  end
+
+  def cmd c,data=[]
+    ret=[]
+    status=0
+    cc=get_ccode(c)
+    @@sem.synchronize do
+      @cs.off 
+      PiPiper::Spi.begin do 
+        clock(@@SPI_CLOCK)
+        status=write cc
+        data.each do |byte|
+          ret << write(byte)
+        end
+      end
+      @cs.on
+      @s[:status]=status
+    end
+    ret
+  end
+
+
+  def rreg reg
+    status=data=0
+    i,bytes =get_address reg
+    cc=get_ccode(:R_REGISTER) +i
+    @@sem.synchronize do
+      @cs.off
+      PiPiper::Spi.begin do 
+        clock(@@SPI_CLOCK)
+        status=write cc
+        if bytes==1
+          data=write(0xff)
+        else
+          data=[]
+          bytes.times do 
+            data << write(0xff)
+          end
+        end
+      end
+      @s[:status]=status
+      @cs.on
+    end
+    [@s[:status],data,bytes,cc]
+  end
+
+  def wreg reg,data
+    i,bytes=get_address reg
+    cc=get_ccode(:W_REGISTER)+i
+    @@sem.synchronize do
+      status=0xff
+      @cs.off
+      PiPiper::Spi.begin do
+        clock(@@SPI_CLOCK)
+        status=write cc
+        if bytes==1
+          write(data)
+        else
+          data.each do |byte|
+            write(byte)
+          end
+        end
+      end
+      @cs.on
+      @s[:status]=status
+    end
+    [@s[:status]]
+  end
+
+  def send packet
+    pac=Array.new(@@PAYLOAD_SIZE, 0)
+    packet.each_with_index do |byte,i|
+      pac[i]=packet[i] if i<@@PAYLOAD_SIZE
+    end
+    @ce.off
+    wreg :CONFIG,0x0a
+    if @s[:params]
+      cmd :W_TX_PAYLOAD,pac
+    else
+      cmd :W_TX_PAYLOAD_NOACK,pac
+    end
+    @ce.on
+    sleep 0.0005
+    @ce.off
+    wreg :CONFIG,0x0b
+    @ce.on
+  end
+
+  def recv 
+    fifo_status,_=rreg :FIFO_STATUS
+    if (fifo_status & 0x01) == 0x01
+      puts "on dataa"
+    end
+  end
+
+  def get_regs all
+    @@regs.each do |k,r|
+      next if not r[:poll] and not all
+      s,d,bytes,code =rreg k
+      @s[:regs][code]=d
+    end
+  end
+
+  def rf_server
+    Thread.new do
+      begin
+        loop do
+          donesome=false
+
+          s,d,b=rreg :FIFO_STATUS
+          if (s&0x40) == 0x40
+            NRF24::note "got RX_DR --received something"
+            wreg :STATUS,0x40
+          end
+          if (s&0x20) == 0x20
+            NRF24::note "got TX_DS --sent something"
+            wreg :STATUS,0x20
+          end
+          if (s&0x10) == 0x10
+            NRF24::note "****************** got MAX_RT --send fails..."
+            wreg :STATUS,0x10
+            @s[:sfail]+=1
+          end
+          if (d&0x01)==0x00
+           ret=cmd :R_RX_PAYLOAD,Array.new(@@PAYLOAD_SIZE, 0xff)
+            @recv_q<<ret
+            @s[:rcnt]+=1
+            donesome=true
+          end
+          if (d&0x02)==0x02
+            ret=cmd :R_RX_PAYLOAD,Array.new(@@PAYLOAD_SIZE, 0xff)
+            @recv_q<<ret
+            @s[:rcnt]+=1
+            @s[:rfull]+=1
+            donesome=true
+          end
+
+          #send rate limiter here :)
+          if not @send_q.empty?
+            if (d&0x20)==0x00
+
+
+              s,d,b=rreg :OBSERVE_TX
+              if (d&0x0f)!=0x00
+                NRF24::note "got ARC_CNT:#{d&0x0f}******************"
+                @s[:sarc]+=d&0x0f
+              end
+
+              msg=@send_q.pop 
+              send msg 
+              @s[:scnt]+=1
+            end
+          end
+          sleep 0.01 if not donesome
+        end
+      rescue Exception =>e
+        puts "do_send fails #{e}"
+        pp e.backtrace
+      end
+    end
+  end
+
+  def do_monitor
+    Thread.new do
+      begin
+        lc=0
+        loop do
+          get_regs(lc%10 == 0)
+          sleep 1
+          lc+=1
+        end
+      rescue Exception =>e
+        puts "do_monitor fails #{e}"
+        pp e.backtrace
+      end
+    end
+  end
+
+  attr_accessor :rcnt,:scnt,:rfull
+  attr_accessor :send_q,:recv_q,:log
+
+  def self.all_devices
+    @@all
+  end
+
+  def self.json
+    devs=[]
+    NRF24::all_devices.each do |data|
+      devs<<data.json
+    end
+    json ={
+      now:Time.now.to_i,
+      devs: devs,
+    }
+    return json
+  end
+
+  def self.register_table
+    @@regs
+  end
+
+  def json 
+    @s
+  end
+
+  def self.get_log 
+    @@log
+  end
+
+  def hw_init hash
+    @s={
+      stamp: 0,
+      params: hash,
+      status: 0,
+      regs: {},
+      rcnt: 0,
+      rfull: 0,
+      scnt: 0,
+      sarc: 0,
+      sfail: 0,
+    } 
+    @id=hash[:id]
+    wreg :CONFIG,0x0b
+    rf_dr=(hash[:rf_dr]||1).to_i&0x01
+    rf_pwr=(hash[:rf_pwr]||3).to_i&0x03
+    lna_hcurr=(hash[:lna_hcurr]||1).to_i&0x01
+    wreg :RF_SETUP,(rf_dr<<3)+(rf_pwr<<1)+lna_hcurr
+    wreg :RF_CH,hash[:chan]||2
+    if hash[:ack]
+      wreg :SETUP_RETR,0x8f
+      wreg :EN_AA,0x7f
+      wreg :DYNPD,0x03
+      wreg :FEATURE,0x00
+    else
+      wreg :SETUP_RETR,0x00
+      wreg :EN_AA,0x00
+      wreg :DYNPD,0x00
+      wreg :FEATURE,0x01
+    end
+    wreg :SETUP_AW,0x03
+    wreg :STATUS,0x70
+    wreg :RX_PW_P0,@@PAYLOAD_SIZE
+    wreg :RX_PW_P1,@@PAYLOAD_SIZE
+    wreg :TX_ADDR,[0x12,0x34,0x56,0x78,0x9a]
+    wreg :RX_ADDR_P0,[0x12,0x34,0x56,0x78,0x9a]
+
+    if hash[:ack]
+      cmd :ACTIVATE,[ 0]
+    else
+      cmd :ACTIVATE,[ get_ccode(:ACTIVATE2)]
+    end
+
+    cmd :FLUSH_TX
+    cmd :FLUSH_RX
+  end
+
+  def initialize(hash={})
+    @semh=Mutex.new 
+
+   
+    @ce=PiPiper::Pin.new(:pin => hash[:ce], :direction => :out)
+    @cs=PiPiper::Pin.new(:pin => hash[:cs], :direction => :out)
+
+    @ce.on
+    @cs.on
+    @@all<<self
+
+    @recv_q=Queue.new
+    @send_q=Queue.new
+
+    hw_init hash
+
+    @server_t=rf_server 
+    @monitor_t=do_monitor
+  end
+end
+

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: nRF24-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ari Siitonen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Pure Ruby Driver and Utilitity with Http-server for the Ultra Cheap
+  Radio Chip nRF24 '
+email: jalopuuverstas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nRF24-ruby.rb
+- examples/nRF24-demo.rb
+- http/json/logger.rb
+- http/json/nRF24.rb
+- http/json/action.rb
+- http/json/init.rb
+- http/coffee/nRF24.coffee
+- http/css/nRF24.css
+- http/haml/index.html
+- http/haml/index.haml
+homepage: https://github.com/arisi/nRF24-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pure Ruby Driver and web-utilitity for Radio Chip nRF24
+test_files: []