tef-furcoms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c612206f7e17733552bcca965b3e2684a5ba17c9
+  data.tar.gz: 6bde1a400cb7e6f6fedbe93f50a0ae0550830e1e
+SHA512:
+  metadata.gz: bc921df1642b8f5ac7cea97fae3080f40c107621c9ae70a7e51fb42a21e14416a67ff64a2e3899d594da5e6721f688e3e2a1322875c6488d293d8b2280b8becd
+  data.tar.gz: 6a1508a0ec5f87fb9c51e43344987f707faa767caebb3095967eba446fe80d3a8dc539a5da8ee9ab0fa9f74d36cf736c1bd5d0200429dc7673ce34905d6babf1

data/README.md

@@ -0,0 +1,6 @@
+
+# TheElectricFursuit FurComs
+
+This... Is a stub for now. Stay tuned for documentation!
+OR!
+Head to github.com/Xasin/system-synth-suit/Ruby/VoiceControl and see how this works.

data/lib/tef/furcoms/Base.rb

@@ -0,0 +1,48 @@
+
+
+module TEF
+	module FurComs
+		class Message
+			attr_reader :priority
+			attr_reader :source_id
+
+			attr_reader :topic
+			attr_reader :data
+
+			def initialize()
+			end
+		end
+
+		class Base
+			def initialize()
+				@message_procs = [];
+			end
+
+			def send_message(topic, message, priority: 0, chip_id: 0) end
+
+			def on_message(topic_filter = nil, &block)
+				@message_procs << { topic: topic_filter, block: block };
+			end
+
+			private def handout_data(topic, data)
+				x_logd("Data received on #{topic}: #{data}")
+
+				@message_procs.each do |callback|
+					begin
+						if filter = callback[:topic]
+							if filter.is_a? String
+								next unless topic == filter
+							elsif filter.is_a? RegExp
+								next unless filter.match(topic)
+							end
+						end
+
+						callback[:block].call(data, topic)
+					rescue => e
+						x_logf("Error in callback #{callback[:block]}: #{e}");
+					end
+				end
+			end
+		end
+	end
+end

data/lib/tef/furcoms/MQTT.rb

@@ -0,0 +1,41 @@
+
+require_relative 'Base.rb'
+
+require 'xasin_logger'
+
+module TEF
+	module FurComs
+		class MQTT < Base
+			include XasLogger::Mix
+
+			def initialize(mqtt, topic = 'FurComs/ttyACM0/')
+				super();
+
+				@mqtt = mqtt;
+				@mqtt_topic = topic;
+
+				@mqtt.subscribe_to topic + 'Received/#' do |data, topic|
+					topic = topic.join('/')
+					next unless topic =~ /^[\w\s\/]*$/
+
+					handout_data(topic, data);
+				end
+
+				init_x_log(@mqtt_topic)
+			end
+
+			def send_message(topic, data, priority: 0, chip_id: 0)
+				unless topic =~ /^[\w\s\/]*$/
+					raise ArgumentError, "Topic includes invalid characters!"
+				end
+				if (topic.length + data.length) > 250
+					raise ArgumentError, "Message packet length exceeded!"
+				end
+
+				x_logd("Sending '#{topic}': '#{data}'")
+
+				@mqtt.publish_to @mqtt_topic + "Send/#{topic}", data
+			end
+		end
+	end
+end

data/lib/tef/furcoms/Serial.rb

@@ -0,0 +1,107 @@
+
+require_relative 'Base.rb'
+
+require 'serialport'
+require 'xasin_logger'
+
+module TEF
+	module FurComs
+		class Serial < Base
+			include XasLogger::Mix
+
+			def initialize(port)
+				super();
+
+				@port = SerialPort.new(port);
+				@port.baud = 115200;
+				@port.sync = true;
+
+				start_thread();
+
+				init_x_log("FurComs #{port}")
+				x_logi("Ready!");
+			end
+
+			private def decode_data_string(data)
+				return if(data.length() < 9)
+				payload = data[8..-1]
+				topic, _sep, payload = payload.partition("\0")
+
+				# Filter out unsafe topics
+				return unless topic =~ /^[\w\s\/]*$/
+
+				handout_data(topic, payload);
+			end
+
+			private def start_thread()
+				@rx_thread = Thread.new() do
+					had_esc = false;
+					rx_buffer = '';
+					c = 0;
+
+					loop do
+						c = @port.getbyte
+						if c == 0
+							decode_data_string rx_buffer
+							rx_buffer = ''
+						elsif had_esc
+							case c
+							when 0xDC
+								rx_buffer += "\0"
+							when 0xDD
+								rx_buffer += "\xDB"
+							end
+							had_esc = false
+						elsif c == 0xDB
+							had_esc = true
+						else
+							rx_buffer += c.chr
+						end
+					end
+				end
+
+				@rx_thread.abort_on_exception = true
+			end
+
+			private def slip_encode_data(data_str)
+				data_str.bytes.map do |b|
+					if b == 0
+						[0xDB, 0xDC]
+					elsif b == 0xDB
+						[0xDB, 0xDD]
+					else
+						b
+					end
+				end.flatten
+			end
+
+			private def generate_furcom_message(priority, chip_id, data_str)
+				priority = ([[-60, priority].max, 60].min + 64) * 2 + 1;
+				chip_id = 0x1 | 0x100 | ((chip_id & 0xEF) << 9) | ((chip_id >> 6) & 0xEF);
+
+				out_data = [0x00, priority, chip_id, 0xFF, 0xFE, 0xFF, 0xFF, 0xFF]
+				out_data += data_str + [0]
+
+				out_data
+			end
+
+			def send_message(topic, message, priority: 0, chip_id: 0)
+				unless topic =~ /^[\w\s\/]*$/
+					raise ArgumentError, "Topic includes invalid characters!"
+				end
+				if (topic.length + message.length) > 250
+					raise ArgumentError, "Message packet length exceeded!"
+				end
+
+				x_logd("Sending '#{topic}': '#{message}'")
+
+				escaped_str = slip_encode_data "#{topic}\0#{message}"
+				out_data = generate_furcom_message priority, chip_id, escaped_str;
+
+				@port.write(out_data.pack("C2S<C*"))
+
+				@port.flush
+			end
+		end
+	end
+end

data/lib/tef/furcoms/SerialToMQTT.rb

@@ -0,0 +1,30 @@
+
+require_relative 'Serial.rb'
+
+module TEF
+	module FurComs
+		class SerialToMQTT < Serial
+			def initialize(port, mqtt, topic = nil)
+				super(port);
+
+				@mqtt = mqtt;
+				@mqtt_topic = topic || "FurComs/#{port.sub('/dev/', '')}/";
+
+				@mqtt.subscribe_to @mqtt_topic + 'Send/#' do |data, topic|
+					topic = topic.join('/')
+
+					next if data.length + topic.length > 250
+					next unless topic =~ /^[\w\s\/]*$/
+
+					self.send_message topic, data
+				end
+			end
+
+			def handout_data(topic, data)
+				super(topic, data);
+
+				@mqtt.publish_to @mqtt_topic + "Received/#{topic}", data
+			end
+		end
+	end
+end

data/lib/tef/furcoms.rb

@@ -0,0 +1,3 @@
+
+require_relative 'furcoms/SerialToMQTT.rb'
+require_relative 'furcoms/MQTT.rb'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: tef-furcoms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TheSystem
+- Xasin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: xasin-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: mqtt-sub_handler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.77.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.77.0
+description: Communication interfaces for TEF FurComs-compatible lines
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/tef/furcoms.rb
+- lib/tef/furcoms/Base.rb
+- lib/tef/furcoms/MQTT.rb
+- lib/tef/furcoms/Serial.rb
+- lib/tef/furcoms/SerialToMQTT.rb
+homepage: 
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby-Gem for TheElectricFursuit FurComs
+test_files: []