Rename to ChirpStack UDP Forwarder.

Author: brocaar

Dockerfile-devel

@@ -24,9 +24,9 @@ RUN mkdir -p /tmp
 RUN cd /tmp && git clone https://github.com/seife/opkg-utils.git && cd /tmp/opkg-utils && PREFIX=/usr make install
 
 ENV LLVM_CONFIG_PATH=llvm-config
-ENV PROJECT_PATH=/chirpstack-udp-bridge
+ENV PROJECT_PATH=/chirpstack-udp-forwarder
 RUN mkdir -p $PROJECT_PATH
 WORKDIR $PROJECT_PATH
 
-COPY . /chirpstack-udp-bridge
+COPY . /chirpstack-udp-forwarder
 RUN cargo fetch

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Orne Brocaar
+Copyright (c) 2022 Orne Brocaar
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,4 +1,7 @@
 VERSION := $(shell git describe --always |sed -e "s/^v//")
 
+devshell:
+	docker-compose run --rm chirpstack-udp-forwarder bash
+
 test:
-	docker-compose run --rm chirpstack-udp-bridge cargo test
+	docker-compose run --rm chirpstack-udp-forwarder cargo test

README.md

@@ -1,15 +1,15 @@
-# ChirpStack UDP Bridge
+# ChirpStack UDP Forwarder
 
-The ChirpStack UDP Bridge is an UDP forwarder for the [ChirpStack Concentratord](https://www.chirpstack.io/concentratord/)
+The ChirpStack UDP Forwarder is an UDP forwarder for the [ChirpStack Concentratord](https://www.chirpstack.io/concentratord/)
 and is compatible with the [Semtech UDP protocol](https://github.com/Lora-net/packet_forwarder/blob/master/PROTOCOL.TXT).
 
 ## Configuration
 
 Configuration example:
 
 ```toml
-# UDP Bridge configuration.
-[udp_bridge]
+# UDP Forwarder configuration.
+[udp_forwarder]
 
   # Log level.
   #
@@ -35,19 +35,19 @@ Configuration example:
 
   # Servers to forward the data to using UDP.
   # This section can be repeated.
-  [[udp_bridge.servers]]
+  [[udp_forwarder.servers]]
     # Server (hostname:port).
     server="localhost:1700"
 
     # Keepalive interval (seconds).
     #
-    # In this interval, the ChirpStack UDP Bridge will send keepalive
+    # In this interval, the ChirpStack UDP Forwarder will send keepalive
     # frames to the server, which must be answered by an acknowledgement.
     keepalive_interval_secs=10
 
     # Max. allowed keepalive failures.
     #
-    # After the max. number has been reached, the ChirpStack UDP Bridge will
+    # After the max. number has been reached, the ChirpStack UDP Forwarder will
     # 're-connect' to the server, meaning it will also re-resolve the DNS in case
     # the server address is a hostname.
     keepalive_max_failures=12
@@ -69,5 +69,5 @@ Configuration example:
 
 ## License
 
-ChirpStack Concentratord is distributed under the MIT license. See
+ChirpStack UDP Forwarder is distributed under the MIT license. See
 [LICENSE](https://github.com/brocaar/chirpstack-udp-bridge/blob/master/LICENSE).

docker-compose.yml

@@ -1,8 +1,8 @@
 version: "2"
 services:
-  chirpstack-udp-bridge:
+  chirpstack-udp-forwarder:
     build:
       context: .
       dockerfile: Dockerfile-devel
     volumes:
-      - ./:/chirpstack-udp-bridge
+      - ./:/chirpstack-udp-forwarder

src/config.rs

@@ -5,7 +5,7 @@ use serde::Deserialize;
 pub const VERSION: &'static str = env!("CARGO_PKG_VERSION");
 
 #[derive(Deserialize, Default)]
-pub struct UDPBridge {
+pub struct UdpForwarder {
     pub log_level: String,
     #[serde(default)]
     pub log_to_syslog: bool,
@@ -28,7 +28,7 @@ pub struct Concentratord {
 
 #[derive(Deserialize)]
 pub struct Configuration {
-    pub udp_bridge: UDPBridge,
+    pub udp_forwarder: UdpForwarder,
     pub concentratord: Concentratord,
 }
 

src/main.rs

@@ -20,10 +20,12 @@ mod socket;
 mod structs;
 
 fn main() {
-    let matches = App::new("chirpstack-udp-bridge")
+    let matches = App::new("chirpstack-udp-forwarder")
         .version(config::VERSION)
         .author("Orne Brocaar <info@brocaar.com>")
-        .about("ChirpStack UDP Bridge for Concentratord, compatible with the Semtech UDP protocol")
+        .about(
+            "ChirpStack UDP Forwarder for Concentratord, compatible with the Semtech UDP protocol",
+        )
         .arg(
             Arg::with_name("config")
                 .short('c')
@@ -39,19 +41,19 @@ fn main() {
     let config_files = matches.values_of_lossy("config").unwrap_or(vec![]);
     let config = config::Configuration::get(config_files).expect("read configuration error");
     let log_level =
-        log::Level::from_str(&config.udp_bridge.log_level).expect("parse log_level error");
+        log::Level::from_str(&config.udp_forwarder.log_level).expect("parse log_level error");
 
     logging::setup(
-        &"chirpstack-udp-bridge",
+        &"chirpstack-udp-forwarder",
         log_level,
-        config.udp_bridge.log_to_syslog,
+        config.udp_forwarder.log_to_syslog,
     )
     .expect("setup logger error");
 
     info!(
-        "Starting ChirpStack UDP Bridge (version: {}, docs: {})",
+        "Starting ChirpStack UDP Forwarder (version: {}, docs: {})",
         config::VERSION,
-        "https://github.com/brocaar/chirpstack-udp-bridge",
+        "https://github.com/chirpstack/chirpstack-udp-forwarder",
     );
 
     // read gateway id.
@@ -67,7 +69,7 @@ fn main() {
     let mut threads: Vec<thread::JoinHandle<()>> = vec![];
 
     // servers
-    for server in config.udp_bridge.servers {
+    for server in config.udp_forwarder.servers {
         threads.push(thread::spawn({
             let gateway_id = gateway_id.clone();
             let event_url = config.concentratord.event_url.clone();
@@ -78,9 +80,9 @@ fn main() {
     }
 
     // metrics
-    if config.udp_bridge.metrics_bind != "" {
+    if config.udp_forwarder.metrics_bind != "" {
         threads.push(thread::spawn({
-            let bind = config.udp_bridge.metrics_bind.clone();
+            let bind = config.udp_forwarder.metrics_bind.clone();
             move || metrics::start(bind)
         }));
     }