├── util ├── mod.rs └── event.rs ├── img └── screenshot.png ├── .gitignore ├── Cargo.toml ├── README.md ├── tagdetail.rs ├── tagtable.rs ├── app.rs ├── main.rs ├── rfid.rs └── LICENSE /util/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod event; 2 | -------------------------------------------------------------------------------- /img/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/russss/epcexplorer/HEAD/img/screenshot.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | 4 | 5 | #Added by cargo 6 | # 7 | #already existing elements are commented out 8 | 9 | #/target 10 | #**/*.rs.bk 11 | Cargo.lock 12 | log 13 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "epcexplorer" 3 | description = "A tool to explore UHF RFID tags" 4 | version = "0.1.2" 5 | license = "GPL-3.0" 6 | readme = "README.md" 7 | repository = "https://github.com/russss/epcexplorer" 8 | authors = ["Russ Garrett "] 9 | edition = "2018" 10 | 11 | [dependencies] 12 | ru5102 = "0.1.1" 13 | invelion = "0.1.2" 14 | gs1 = "0.1.4" 15 | tui = "0.6.2" 16 | termion = "1.5" 17 | failure = "0.1.5" 18 | hex = "0.3.1" 19 | clap = "2.33.0" 20 | log = "0.4.8" 21 | flexi_logger = "0.14.4" 22 | backtrace = "0.3.38" 23 | 24 | [[bin]] 25 | name = "epcexplorer" 26 | path = "main.rs" 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # EPC Explorer 2 | 3 | A tool to explore UHF RFID tags, written in Rust. Electronic Product Code (EPC) fields are decoded using the [GS1](https://crates.io/crates/gs1) crate. 4 | 5 | ![Screenshot](/img/screenshot.png) 6 | 7 | ## Supported Readers 8 | 9 | * CH-RU5102 (`ru5102` driver) 10 | * Invelion and similar (`invelion` driver) 11 | 12 | ## Installing 13 | 14 | Assuming you have the Rust toolchain installed, you can install with : 15 | 16 | $ cargo install epcexplorer 17 | 18 | ## Running 19 | 20 | Pass the serial device name and driver name to the binary - in my case: 21 | 22 | $ epcexplorer /dev/cu.SLAB_USBtoUART ru5102 23 | -------------------------------------------------------------------------------- /tagdetail.rs: -------------------------------------------------------------------------------- 1 | use crate::rfid::ScanResult; 2 | use crate::block; 3 | use tui::layout::Rect; 4 | use gs1::epc; 5 | use tui::buffer::Buffer; 6 | use tui::style::{Style, Modifier}; 7 | use tui::widgets::{Widget, Text, Paragraph}; 8 | 9 | pub(crate) struct TagDetail<'a> { 10 | pub item: Option<&'a ScanResult> 11 | } 12 | 13 | impl<'a> TagDetail<'a> { 14 | pub fn new(item: Option<&'a ScanResult>) -> TagDetail<'a> { 15 | TagDetail { 16 | item: item 17 | } 18 | } 19 | } 20 | 21 | fn render_detail(item: &ScanResult) -> Vec { 22 | let mut header = format!("Tag ID: {}", hex::encode_upper(&item.epc)); 23 | match epc::decode_binary(&item.epc) { 24 | Ok(val) => { 25 | header.push_str(&format!(" ({})", val.to_uri())); 26 | } 27 | Err(_) => {} 28 | }; 29 | header.push('\n'); 30 | 31 | vec![ 32 | Text::styled(header, Style::default().modifier(Modifier::BOLD)), 33 | Text::raw(match item.tid { 34 | Some(tid) => format!("{:?}\n", tid), 35 | None => "".to_string() 36 | }), 37 | Text::raw(match item.xtid_header { 38 | Some(xtid) => format!("{:?}\n", xtid), 39 | None => "".to_string() 40 | }), 41 | Text::raw(match &item.serial { 42 | Some(serial) => format!("Serial: {}", hex::encode(serial)), 43 | None => "".to_string() 44 | }) 45 | ] 46 | } 47 | 48 | impl<'a> Widget for TagDetail<'a> { 49 | fn draw(&mut self, area: Rect, buf: &mut Buffer) { 50 | 51 | let text = match self.item { 52 | Some(item) => render_detail(&item), 53 | None => vec![] 54 | }; 55 | 56 | Paragraph::new(text.iter()) 57 | .block(block("Detail")) 58 | .wrap(true) 59 | .draw(area, buf); 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /util/event.rs: -------------------------------------------------------------------------------- 1 | use std::io; 2 | use std::sync::mpsc; 3 | use std::thread; 4 | use std::time::Duration; 5 | 6 | use termion::event::Key; 7 | use termion::input::TermRead; 8 | 9 | pub enum Event { 10 | Input(I), 11 | Tick, 12 | } 13 | 14 | /// A small event handler that wrap termion input and tick events. Each event 15 | /// type is handled in its own thread and returned to a common `Receiver` 16 | #[allow(dead_code)] 17 | pub struct Events { 18 | rx: mpsc::Receiver>, 19 | input_handle: thread::JoinHandle<()>, 20 | tick_handle: thread::JoinHandle<()>, 21 | } 22 | 23 | #[derive(Debug, Clone, Copy)] 24 | pub struct Config { 25 | pub exit_key: Key, 26 | pub tick_rate: Duration, 27 | } 28 | 29 | impl Default for Config { 30 | fn default() -> Config { 31 | Config { 32 | exit_key: Key::Char('q'), 33 | tick_rate: Duration::from_millis(250), 34 | } 35 | } 36 | } 37 | 38 | impl Events { 39 | pub fn new() -> Events { 40 | Events::with_config(Config::default()) 41 | } 42 | 43 | pub fn with_config(config: Config) -> Events { 44 | let (tx, rx) = mpsc::channel(); 45 | let input_handle = { 46 | let tx = tx.clone(); 47 | thread::spawn(move || { 48 | let stdin = io::stdin(); 49 | for evt in stdin.keys() { 50 | match evt { 51 | Ok(key) => { 52 | if let Err(_) = tx.send(Event::Input(key)) { 53 | return; 54 | } 55 | if key == config.exit_key { 56 | return; 57 | } 58 | } 59 | Err(_) => {} 60 | } 61 | } 62 | }) 63 | }; 64 | let tick_handle = { 65 | let tx = tx.clone(); 66 | thread::spawn(move || { 67 | let tx = tx.clone(); 68 | loop { 69 | tx.send(Event::Tick).unwrap(); 70 | thread::sleep(config.tick_rate); 71 | } 72 | }) 73 | }; 74 | Events { 75 | rx, 76 | input_handle, 77 | tick_handle, 78 | } 79 | } 80 | 81 | pub fn next(&self) -> Result, mpsc::RecvError> { 82 | self.rx.recv() 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /tagtable.rs: -------------------------------------------------------------------------------- 1 | use crate::rfid::ScanResult; 2 | use crate::block; 3 | use tui::layout::Rect; 4 | use tui::buffer::Buffer; 5 | use tui::widgets::{Widget, Table, Row}; 6 | use tui::style::{Color, Style, Modifier}; 7 | use gs1::{epc, epc::tid::mdid_name, epc::tid::tmid_name}; 8 | 9 | fn render_row(item: &ScanResult) -> Vec { 10 | let mut epc_str = match epc::decode_binary(&item.epc) { 11 | Ok(val) => val.to_uri(), 12 | Err(_) => hex::encode_upper(&item.epc) 13 | }; 14 | 15 | if epc_str == "urn:epc:id:unprogrammed" { 16 | epc_str = hex::encode_upper(&item.epc); 17 | } 18 | 19 | vec![ 20 | epc_str, 21 | match item.tid { 22 | Some(tid) => mdid_name(&tid.mdid).to_string(), 23 | None => "".to_string() 24 | }, 25 | match item.tid { 26 | Some(tid) => match tmid_name(&tid.mdid, &tid.tmid) { 27 | "Unknown" => format!("0x{:X}", &tid.tmid), 28 | found => found.to_string() 29 | }, 30 | None => "".to_string() 31 | }, 32 | match item.xtid_header { 33 | Some(_) => "Y", 34 | None => "" 35 | }.to_string(), 36 | match item.serial { 37 | Some(_) => "Y", 38 | None => "" 39 | }.to_string(), 40 | match item.rssi { 41 | Some(val) => format!("{}", val), 42 | None => "".to_string() 43 | }, 44 | match item.antenna { 45 | Some(val) => format!("{}", val), 46 | None => "".to_string() 47 | }, 48 | format!("{}s", item.last_seen.elapsed().as_secs()) 49 | ] 50 | } 51 | 52 | 53 | pub(crate) struct TagTable<'a> { 54 | pub items: &'a Vec<&'a ScanResult>, 55 | pub selected: Option> 56 | } 57 | 58 | impl<'a> TagTable<'a> { 59 | pub fn new(items: &'a Vec<&'a ScanResult>, selected: Option>) -> TagTable<'a> { 60 | TagTable { 61 | items: items, 62 | selected: selected 63 | } 64 | } 65 | } 66 | 67 | impl<'a> Widget for TagTable<'a> { 68 | fn draw(&mut self, area: Rect, buf: &mut Buffer) { 69 | let header = ["ID", "Manufacturer", "Model", "XTID", "Serial", "RSSI", "Ant", "Age"]; 70 | let selected_style = Style::default().fg(Color::Yellow); 71 | let normal_style = Style::default(); 72 | let rows = self.items.iter().map(|item| { 73 | let mut style = normal_style; 74 | if item.last_seen.elapsed().as_secs() > 2 { 75 | style = style.fg(Color::Gray); 76 | } 77 | match &self.selected { 78 | Some(selected) => { 79 | if &item.epc == selected { 80 | style = selected_style; 81 | } 82 | } 83 | None => {} 84 | }; 85 | 86 | let cols = render_row(item).into_iter(); 87 | Row::StyledData(cols, style) 88 | }); 89 | Table::new(header.into_iter(), rows) 90 | .header_style(Style::default().modifier(Modifier::BOLD)) 91 | .block(block("Tags")) 92 | .widths(&[50, 25, 10, 6, 6, 8, 6, 9]) 93 | .draw(area, buf); 94 | } 95 | } 96 | -------------------------------------------------------------------------------- /app.rs: -------------------------------------------------------------------------------- 1 | use crate::rfid::ScanResult; 2 | use std::cmp; 3 | use std::collections::HashMap; 4 | use std::sync::mpsc; 5 | use std::time; 6 | 7 | const INACTIVE_AGE: time::Duration = time::Duration::from_secs(5); 8 | 9 | pub(crate) struct App { 10 | pub items: HashMap, ScanResult>, 11 | pub selected: Option>, 12 | pub show_inactive: bool, 13 | } 14 | 15 | impl ScanResult { 16 | fn active(&self) -> bool { 17 | self.last_seen.elapsed() < INACTIVE_AGE 18 | } 19 | } 20 | 21 | impl App { 22 | pub fn new() -> App { 23 | App { 24 | items: HashMap::new(), 25 | selected: None, 26 | show_inactive: false, 27 | } 28 | } 29 | 30 | pub fn update_items(&mut self, rx: &mpsc::Receiver) { 31 | loop { 32 | match rx.try_recv() { 33 | Ok(result) => { 34 | let epc = result.epc.to_vec(); 35 | match self.items.get_mut(&epc) { 36 | Some(item) => { 37 | item.update(result); 38 | } 39 | None => { 40 | self.items.insert(epc, result); 41 | } 42 | }; 43 | } 44 | Err(_) => { 45 | break; 46 | } 47 | }; 48 | } 49 | let items = self.get_items(); 50 | if items.len() > 0 { 51 | match self.selected { 52 | None => { 53 | self.selected = Some(items[0].epc.to_vec()); 54 | } 55 | _ => {} 56 | } 57 | } else { 58 | self.selected = None; 59 | } 60 | } 61 | 62 | pub fn update_selected(&mut self, reverse: bool) { 63 | let items = self.get_items(); 64 | 65 | let selected = match &self.selected { 66 | Some(epc) => epc.to_vec(), 67 | None => { 68 | self.selected = Some(items[0].epc.to_vec()); 69 | return; 70 | } 71 | }; 72 | 73 | let mut selected_index = 0; 74 | for (i, item) in items.iter().enumerate() { 75 | if item.epc == selected { 76 | selected_index = i; 77 | break; 78 | } 79 | } 80 | 81 | if selected_index == 0 && reverse { 82 | selected_index = items.len() - 1; 83 | } else if selected_index == items.len() - 1 && !reverse { 84 | selected_index = 0; 85 | } else if reverse { 86 | selected_index -= 1; 87 | } else { 88 | selected_index += 1; 89 | } 90 | 91 | self.selected = Some(items[selected_index].epc.to_vec()); 92 | } 93 | 94 | pub fn get_items(&self) -> Vec<&ScanResult> { 95 | let mut items: Vec<&ScanResult> = self.items.iter().filter_map( 96 | |(_, item)| 97 | if !item.active() && !self.show_inactive { 98 | None 99 | } else { 100 | Some(item) 101 | } 102 | ).collect(); 103 | items.sort_by_key(|res| { 104 | ( 105 | cmp::max(res.last_seen.elapsed(), INACTIVE_AGE), 106 | res.epc.to_owned(), 107 | ) 108 | }); 109 | items 110 | } 111 | } 112 | -------------------------------------------------------------------------------- /main.rs: -------------------------------------------------------------------------------- 1 | mod util; 2 | 3 | extern crate clap; 4 | extern crate failure; 5 | extern crate flexi_logger; 6 | extern crate gs1; 7 | extern crate hex; 8 | extern crate invelion; 9 | extern crate log; 10 | extern crate ru5102; 11 | extern crate termion; 12 | extern crate tui; 13 | extern crate backtrace; 14 | 15 | mod app; 16 | mod rfid; 17 | mod tagdetail; 18 | mod tagtable; 19 | 20 | use std::io; 21 | use std::panic; 22 | use std::sync::mpsc; 23 | use std::thread; 24 | use std::process; 25 | 26 | use crate::app::App; 27 | use crate::rfid::{scan_thread, ReaderType, ScanResult, ScanSettings}; 28 | use crate::tagdetail::TagDetail; 29 | use crate::tagtable::TagTable; 30 | 31 | use clap::{App as Clap, Arg}; 32 | use failure::bail; 33 | use log::error; 34 | use termion::event::Key; 35 | use termion::input::MouseTerminal; 36 | use termion::raw::IntoRawMode; 37 | use termion::screen::AlternateScreen; 38 | use tui::backend::TermionBackend; 39 | use tui::layout::{Constraint, Layout}; 40 | use tui::style::{Color, Style}; 41 | use tui::widgets::{Block, Borders, Widget}; 42 | use tui::Terminal; 43 | use backtrace::Backtrace; 44 | 45 | use crate::util::event::{Event, Events}; 46 | 47 | fn init_rfid( 48 | driver: &str, 49 | port: &str, 50 | ) -> Result<(mpsc::Receiver, mpsc::Sender), failure::Error> { 51 | let reader_type = match driver { 52 | "ru5102" => ReaderType::RU5102(ru5102::Reader::new(port)?), 53 | "invelion" => ReaderType::Invelion(invelion::Reader::new(port, 1, 4)?), 54 | _ => { 55 | bail!("Invalid reader type (shouldn't happen)"); 56 | } 57 | }; 58 | 59 | let (scan_tx, scan_rx) = mpsc::channel(); 60 | let (settings_tx, settings_rx) = mpsc::channel(); 61 | thread::spawn(move || { 62 | scan_thread(reader_type, scan_tx, settings_rx); 63 | }); 64 | Ok((scan_rx, settings_tx)) 65 | } 66 | 67 | fn main() -> Result<(), failure::Error> { 68 | let matches = Clap::new("EPC Explorer") 69 | .arg( 70 | Arg::with_name("PORT") 71 | .help("Serial port for reader") 72 | .required(true), 73 | ) 74 | .arg( 75 | Arg::with_name("DRIVER") 76 | .help("Driver to use") 77 | .possible_values(&["ru5102", "invelion"]) 78 | .required(true), 79 | ) 80 | .arg( 81 | Arg::with_name("log") 82 | .short("l") 83 | .value_name("DIRECTORY") 84 | .help("Write debug logs to files in DIRECTORY") 85 | .takes_value(true), 86 | ) 87 | .get_matches(); 88 | 89 | if let Some(log_dir) = matches.value_of("log") { 90 | flexi_logger::Logger::with_str("debug, tui=warn") 91 | .log_to_file() 92 | .format(flexi_logger::with_thread) 93 | .directory(log_dir) 94 | .start() 95 | .unwrap(); 96 | } 97 | 98 | let (scan_rx, _settings_tx) = init_rfid( 99 | matches.value_of("DRIVER").unwrap(), 100 | matches.value_of("PORT").unwrap(), 101 | )?; 102 | 103 | panic::set_hook(Box::new(panic_hook)); 104 | 105 | let stdout = io::stdout().into_raw_mode()?; 106 | let stdout = MouseTerminal::from(stdout); 107 | let stdout = AlternateScreen::from(stdout); 108 | let backend = TermionBackend::new(stdout); 109 | let mut terminal = Terminal::new(backend)?; 110 | terminal.hide_cursor()?; 111 | 112 | let events = Events::new(); 113 | 114 | let mut app = App::new(); 115 | 116 | loop { 117 | terminal.draw(|mut f| { 118 | let items = app.get_items(); 119 | let selected = app.selected.to_owned(); 120 | let selected_item = match selected { 121 | Some(epc) => app.items.get(&epc), 122 | None => None, 123 | }; 124 | let rects = Layout::default() 125 | .constraints([Constraint::Percentage(80), Constraint::Percentage(20)].as_ref()) 126 | .split(f.size()); 127 | TagTable::new(&items, app.selected.to_owned()).render(&mut f, rects[0]); 128 | TagDetail::new(selected_item).render(&mut f, rects[1]); 129 | })?; 130 | 131 | match events.next()? { 132 | Event::Input(key) => match key { 133 | Key::Char('q') => { 134 | break; 135 | } 136 | Key::Char('i') => { 137 | app.show_inactive = !app.show_inactive; 138 | } 139 | Key::Down => { 140 | app.update_selected(false); 141 | } 142 | Key::Up => { 143 | app.update_selected(true); 144 | } 145 | _ => {} 146 | }, 147 | Event::Tick => { 148 | app.update_items(&scan_rx); 149 | } 150 | }; 151 | } 152 | 153 | Ok(()) 154 | } 155 | 156 | pub(crate) fn block<'a>(title: &'a str) -> Block<'a> { 157 | Block::default() 158 | .borders(Borders::ALL) 159 | .title(title) 160 | .title_style(Style::default().fg(Color::Red)) 161 | } 162 | 163 | fn panic_hook(info: &panic::PanicInfo<'_>) { 164 | let backtrace = Backtrace::new(); 165 | let thread = thread::current(); 166 | let thread = thread.name().unwrap_or("unnamed"); 167 | 168 | let msg = match info.payload().downcast_ref::<&'static str>() { 169 | Some(s) => *s, 170 | None => match info.payload().downcast_ref::() { 171 | Some(s) => &s[..], 172 | None => "Box", 173 | }, 174 | }; 175 | match info.location() { 176 | Some(location) => { 177 | error!( 178 | target: "panic", "thread '{}' panicked at '{}': {}:{}\n{:?}", 179 | thread, 180 | msg, 181 | location.file(), 182 | location.line(), 183 | backtrace 184 | ); 185 | } 186 | None => error!( 187 | target: "panic", 188 | "thread '{}' panicked at '{}'\n{:?}", 189 | thread, 190 | msg, 191 | backtrace 192 | ), 193 | } 194 | println!( 195 | "{}thread '' panicked at '{}'. See log for more info.\r", 196 | termion::screen::ToMainScreen, 197 | msg 198 | ); 199 | process::exit(1); 200 | } 201 | -------------------------------------------------------------------------------- /rfid.rs: -------------------------------------------------------------------------------- 1 | use gs1::epc::tid::{decode_tid, decode_xtid_header, XTIDHeader, TID}; 2 | use log::warn; 3 | //use std::collections::HashSet; 4 | use std::sync::mpsc; 5 | use std::time; 6 | use log::debug; 7 | 8 | pub(crate) enum ReaderType { 9 | Invelion(invelion::Reader), 10 | RU5102(ru5102::Reader), 11 | } 12 | 13 | pub(crate) struct ScanSettings { 14 | pub detailed_scan: bool, 15 | } 16 | 17 | impl ScanSettings { 18 | pub fn default() -> ScanSettings { 19 | ScanSettings { 20 | detailed_scan: true, 21 | } 22 | } 23 | } 24 | 25 | #[derive(Debug, Clone, PartialEq)] 26 | pub(crate) struct ScanResult { 27 | pub epc: Vec, 28 | pub tid: Option, 29 | pub xtid_header: Option, 30 | pub serial: Option>, 31 | pub rssi: Option, 32 | pub antenna: Option, 33 | pub last_seen: time::Instant, 34 | } 35 | 36 | impl ScanResult { 37 | pub fn from_epc(epc: Vec) -> ScanResult { 38 | ScanResult { 39 | epc: epc, 40 | tid: None, 41 | xtid_header: None, 42 | serial: None, 43 | rssi: None, 44 | antenna: None, 45 | last_seen: time::Instant::now(), 46 | } 47 | } 48 | 49 | pub fn update(&mut self, other: ScanResult) { 50 | assert_eq!(self.epc, other.epc); 51 | self.tid = match other.tid { 52 | Some(tid) => Some(tid), 53 | None => self.tid, 54 | }; 55 | self.xtid_header = match other.xtid_header { 56 | Some(xtid) => Some(xtid), 57 | None => self.xtid_header, 58 | }; 59 | self.serial = match other.serial { 60 | Some(serial) => Some(serial), 61 | None => self.serial.to_owned(), 62 | }; 63 | self.rssi = match other.rssi { 64 | Some(rssi) => Some(rssi), 65 | None => self.rssi 66 | }; 67 | self.antenna = other.antenna; 68 | self.last_seen = other.last_seen; 69 | } 70 | } 71 | 72 | fn read_tid( 73 | reader: &mut ru5102::Reader, 74 | uid: &Vec, 75 | start: u8, 76 | words: u8, 77 | ) -> Result, ru5102::error::Error> { 78 | let read_cmd = ru5102::ReadCommand { 79 | epc: uid.to_owned(), 80 | location: ru5102::MemoryLocation::TID, 81 | start_address: start, 82 | count: words, 83 | password: None, 84 | mask_address: None, 85 | mask_length: None, 86 | }; 87 | 88 | reader.read_data(read_cmd) 89 | } 90 | 91 | fn get_details_ru5102( 92 | tags: &[ScanResult], 93 | reader: &mut ru5102::Reader, 94 | ) -> Vec { 95 | tags.iter().map(|tag| get_tag_details_ru5102(tag, reader)).collect() 96 | } 97 | 98 | fn get_tag_details_ru5102(tag: &ScanResult, reader: &mut ru5102::Reader) -> ScanResult { 99 | let mut tag = tag.to_owned(); 100 | tag.tid = match read_tid(reader, &tag.epc, 0, 2) { 101 | Ok(res) => { 102 | debug!("Read TID: {:?}", res); 103 | Some(decode_tid(&res).unwrap()) 104 | }, 105 | Err(_err) => None 106 | }; 107 | 108 | tag.xtid_header = match tag.tid { 109 | Some(tid) => { 110 | if tid.xtid { 111 | match read_tid(reader, &tag.epc, 2, 1) { 112 | Ok(res) => match decode_xtid_header(&res) { 113 | Ok(header) => Some(header), 114 | Err(_) => None, 115 | }, 116 | Err(_) => None, 117 | } 118 | } else { 119 | None 120 | } 121 | } 122 | None => None, 123 | }; 124 | 125 | tag.serial = match read_tid(reader, &tag.epc, 2, 3) { 126 | Ok(data) => Some(data), 127 | Err(_) => None, 128 | }; 129 | 130 | tag 131 | } 132 | 133 | fn scan_ru5102(reader: &mut ru5102::Reader) -> Vec { 134 | let mut result = Vec::new(); 135 | let inv = reader.inventory().unwrap(); 136 | if inv.len() > 0 { 137 | for uid in inv.iter() { 138 | result.push(ScanResult::from_epc(uid.to_owned())); 139 | } 140 | } 141 | result 142 | } 143 | 144 | fn scan_invelion(reader: &mut invelion::Reader) -> invelion::error::Result> { 145 | let mut result = Vec::new(); 146 | for i in 0..4 { 147 | reader.set_work_antenna(i)?; 148 | let inv = reader.real_time_inventory(255)?; 149 | for item in inv.items.iter() { 150 | let mut res = ScanResult::from_epc(item.epc.to_owned()); 151 | res.rssi = Some(item.rssi); 152 | res.antenna = Some(item.antenna); 153 | result.push(res); 154 | } 155 | } 156 | Ok(result) 157 | } 158 | 159 | fn get_details_invelion( 160 | reader: &mut invelion::Reader, 161 | antenna: u8 162 | ) -> invelion::error::Result> { 163 | reader.set_work_antenna(antenna)?; 164 | let data = reader.read(invelion::protocol::MemoryBank::TID, &[0, 0, 0, 0], 0, 2)?; 165 | Ok(data.iter().map(|response| 166 | ScanResult { 167 | epc: response.epc.to_owned(), 168 | tid: match decode_tid(&response.data) { 169 | Ok(tid) => Some(tid), 170 | Err(_) => {warn!("decode_tid error: {:?}", response.data); 171 | None 172 | } 173 | }, 174 | rssi: None, 175 | antenna: Some(response.antenna), 176 | xtid_header: None, 177 | serial: None, 178 | last_seen: time::Instant::now() 179 | } 180 | ).collect()) 181 | } 182 | 183 | fn scan(reader_type: &mut ReaderType) -> Vec { 184 | match reader_type { 185 | ReaderType::Invelion(reader) => match scan_invelion(reader) { 186 | Ok(result) => result, 187 | Err(err) => { 188 | warn!("Scan error: {:?}", err); 189 | vec![] 190 | } 191 | }, 192 | ReaderType::RU5102(reader) => scan_ru5102(reader), 193 | } 194 | } 195 | 196 | pub(crate) fn scan_thread( 197 | mut reader_type: ReaderType, 198 | tx: mpsc::Sender, 199 | settings_rx: mpsc::Receiver, 200 | ) { 201 | let mut settings = ScanSettings::default(); 202 | let mut detailed_scan_antenna = 0; 203 | loop { 204 | match settings_rx.try_recv() { 205 | Ok(new_settings) => { 206 | settings = new_settings; 207 | } 208 | Err(_) => {} 209 | } 210 | let tags = scan(&mut reader_type); 211 | for tag in tags.iter() { 212 | tx.send(tag.to_owned()).unwrap(); 213 | } 214 | 215 | if settings.detailed_scan { 216 | let tags = match &mut reader_type { 217 | ReaderType::Invelion(reader) => match get_details_invelion(reader, detailed_scan_antenna) { 218 | Ok(result) => result, 219 | Err(err) => { 220 | warn!("Detailed scan error: {:?}", err); 221 | vec![] 222 | } 223 | }, 224 | ReaderType::RU5102(reader) => get_details_ru5102(&tags, reader) 225 | }; 226 | for tag in tags { 227 | tx.send(tag).unwrap(); 228 | } 229 | 230 | detailed_scan_antenna = (detailed_scan_antenna + 1) % 4; 231 | } 232 | } 233 | } 234 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------