bitwizard 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2f5266eca9ddb2e732db8ff87c674881adf6f1a
-  data.tar.gz: 1646160e172499d225f23b04519bb8d12b6d425d
+  metadata.gz: 23272ef83658a302c5044c1b5595726519d7bea9
+  data.tar.gz: cc86e53099c37b6c5ef21374957101ede0d951e3
 SHA512:
-  metadata.gz: c965fdbf80b846d6e6e2a22bd1861cf0ac66303148214e4c72a096bcce55ab54d533f5b31434cdc2bbc2c0375366d1b830b07b3b45f7d94b53f4aceb6024cac5
-  data.tar.gz: 2e97dd74df33ead09a1d70f5bf49ceeb35643c14f76d06b898cc1673e35a4328e40960b30c7fe0c6948297508293c19076d7fb0e588a966c245deae09e5767e5
+  metadata.gz: 343f4e71083472dfa41c755fcf1a7da50f2d4ccdfcb2d58e5a332cc01650a847b422d9f2303336c709b624a6ee14cc2e4ebbcf682922ec0d4bfc41433ac33766
+  data.tar.gz: 31e561c6996c160e9fd222a561ac6fecbe88d6ae67f85091d0c478fffe93ee172d2588909d7892c75c09218cb5eda58727ccf4564adf868917ac673c8be9c051

data/bin/bitwizardctl

@@ -11,23 +11,24 @@ class BasicLogger
 end
 
 Options = {
-	:bus => :spi,
-	:verbose => false,
-	:scan => true
+	bus: :spi,
+	verbose: false,
+	scan: true
 }
 
 class BitWizardCTL
 
 	DetailedHelp = {
-		:scan => { :text => "Scans for available boards" },
-		:list => { :text => "Lists all the found boards" },
-		:eeprom => { :args => "<addr>", :text => "Read the eeprom from the specified address(es), or all found boards if none given" },
-		:exit => { :text => "Exits the program" },
-		:help => { :text => "Lists all the valid commands, or detailed help for a given command" },
-		:pwm => { :args => "<addr> [port [value/'enable'/'disable']]", :text => "Get/Set the PWM value for a certain port on a board" },
-		:stepper => { :args => "<addr> <'current'/'target'/'delay'> [value]", :text => "Get/Set a value for a stepper motor on the specified board" },
-		:motor => { :args => "<addr> <'A'/'B'> <speed/'stop'>", :text => "Change speed of a motor on the specified board" }
-	}
+		scan: { text: "Scans for available boards" },
+		list: { text: "Lists all the found boards" },
+		eeprom: { args: "<addr>", text: "Read the eeprom from the specified address(es), or all found boards if none given" },
+		features: { args: "<addr>", text: "Returns all of the features of the specified board" },
+		exit: { text: "Exits the program" },
+		help: { text: "Lists all the valid commands, or detailed help for a given command" },
+		pwm: { args: "<addr> [port [value/'enable'/'disable']]", text: "Get/Set the PWM value for a certain port on a board" },
+		stepper: { args: "<addr> <'current'/'target'/'delay'> [value]", text: "Get/Set a value for a stepper motor on the specified board" },
+		motor: { args: "<addr> <'A'/'B'> <speed/'stop'>", text: "Change speed of a motor on the specified board" }
+	}.sort
 
 	def initialize
 		@defaultlogger = BasicLogger.new if Options[:verbose]
@@ -130,7 +131,7 @@ class BitWizardCTL
 	def get_board(addr)
 		board = @boards[addr] if @boards.has_key? addr
 		unless board then
-			board = BitWizard::Board.detect :address => addr, :bus => Options[:bus], :logger => (@defaultlogger if Options[:verbose])
+			board = BitWizard::Board.detect address: addr, bus: Options[:bus], logger: (@defaultlogger if Options[:verbose])
 			@boards[addr] = board if board.valid?
 		end
 
@@ -162,7 +163,7 @@ class BitWizardCTL
 		@boards = { }
 		(0..0xff).step(2) do |address|
 			begin
-				temp = BitWizard::Board.detect :address => address, :bus => Options[:bus], :logger => (@defaultlogger if Options[:verbose])
+				temp = BitWizard::Board.detect address: address, bus: Options[:bus], logger: (@defaultlogger if Options[:verbose])
 				next unless temp.valid?
 
 				@boards[temp.address] = temp
@@ -178,6 +179,15 @@ class BitWizardCTL
 		end
 	end
 
+	def cmd_features(*args)
+		raise ArgumentError.new "Wrong number of arguments (#{args.count} for 1)" unless args.count == 1
+
+		addr = parse_addr args[0]
+		board = get_board addr
+
+		puts "0x#{addr.to_s(16)}: #{board.features.join(", ")}"
+	end
+
 	def cmd_eeprom(*args)
 		if args.count == 0 then
 			@boards.each do |_, board|
@@ -207,7 +217,7 @@ class BitWizardCTL
 		addr = parse_addr addr
 		board = get_board addr
 
-		raise ArgumentError.new "Board doesn't support PWM actions" unless board.known_board[:features].include? :pwm
+		raise ArgumentError.new "Board doesn't support PWM actions" unless board.features.include? :pwm
 
 		puts "0x#{addr.to_s(16)}:"
 
@@ -247,7 +257,7 @@ class BitWizardCTL
 		addr = parse_addr addr
 		board = get_board addr
 
-		raise ArgumentError.new "Board doesn't support stepper actions" unless board.known_board[:features].include? :stepper
+		raise ArgumentError.new "Board doesn't support stepper actions" unless board.features.include? :stepper
 
 		case type
 		when :current
@@ -275,7 +285,7 @@ class BitWizardCTL
 		addr = parse_addr addr
 		board = get_board addr
 
-		raise ArgumentError.new "Board doesn't support motor actions" unless board.known_board[:features].include? :motor
+		raise ArgumentError.new "Board doesn't support motor actions" unless board.features.include? :motor
 
 		if value.is_a? String
 			board.motor_stop motor

data/lib/bitwizard.rb

@@ -12,27 +12,27 @@ module BitWizard
 		# @option options [Logger] :logger A logger you want to attach to the board.
 		def Board.detect(options)
 			options = {
-				:address => -1,
-				:bus => :spi,
-				:logger => NullLogger.new
+				address: -1,
+				bus: :spi,
+				logger: NullLogger.new
 			}.merge(options).merge({
-				:type => :auto_detect,
-				:skip_check => false
+				type: :auto_detect,
+				skip_check: false
 			})
 
 			options[:logger] = NullLogger.new unless options[:logger]
 
 			temp = BitWizard::Board.new options
-			correct = temp.known_board[:constructor].call(options.merge({:skip_check => true})) if temp.valid?
+			correct = temp.instance_variable_get(:@constructor).call(options.merge({skip_check: true})) if temp.valid?
 
 			correct.instance_variable_set(:@type, temp.type)
 			correct.instance_variable_set(:@version, temp.version)
-			correct.instance_variable_set(:@known_board, temp.known_board)
+			correct.instance_variable_set(:@features, temp.features)
 
 			correct
 		end
 
-		attr_reader :type, :version, :address, :bus, :known_board
+		attr_reader :type, :version, :address, :bus, :features
 		attr_accessor :logger
 
 		#Creates a generic board handle for reading and writing directly.
@@ -42,14 +42,16 @@ module BitWizard
 		# @option options [Symbol] :type The board type, defaults to auto detecting. (identifier)
 		# @option options [Symbol] :bus The bus it's connected to. (:spi or :i2c)
 		# @option options [Boolean] :skip_check Skip the self check that runs on creation.
+		# @option options [Number] :clock The clockrate you want to run the communication with.
 		# @option options [Logger] :logger Add a logger here to log data that's sent and received.
 		def initialize(options)
 			options = {
-				:address => -1,
-				:type => :auto_detect,
-				:bus => :spi,
-				:skip_check => false,
-				:logger => NullLogger.new
+				address: -1,
+				type: :auto_detect,
+				bus: :spi,
+				skip_check: false,
+				clock: 45000,
+				logger: NullLogger.new
 			}.merge(options)
 
 			raise ArgumentError.new "Bus must be :spi or :i2c." unless options[:bus] == :spi or options[:bus] == :i2c
@@ -102,6 +104,7 @@ module BitWizard
 		def address=(new_address)
 			raise ArgumentError.new "#{new_address} is not a valid address" unless new_address.is_a? Fixnum and (0..255).include? new_address and new_address|1 != new_address
 
+			# Run a quick check so that there isn't a board on the other address.
 			old_address = @address
 			@address = new_address
 			identifier = read(0x01, 20).pack("C*").split("\0")[0]
@@ -113,8 +116,11 @@ module BitWizard
 				end
 			end
 
-			write 0xf1, 0x55
+			# Unlock the change register
+			write 0xf1, 0x55 
 			write 0xf2, 0xaa
+
+			# Perform the change
 			write 0xf0, new_address
 
 			@address = new_address
@@ -135,8 +141,8 @@ module BitWizard
 				if name =~ @type then
 					@address = data[:default_address] unless (0..255).include? @address
 					found_board = {
-						:name => name,
-						:data => data
+						name: name,
+						data: data
 					}
 					break
 				end
@@ -145,14 +151,15 @@ module BitWizard
 			raise ArgumentError.new "Board type is 'auto_detect', but invalid address #{@address} given." if @type == :auto_detect and not (0..255).include? @address
 
 			identifier = read(0x01, 20).pack("C*").split("\0")[0]
-			raise ArgumentError.new "No response from board" if identifier.empty?
+			raise ArgumentError.new "No response from board" if not identifier or identifier.empty?
 
 			if @type == :auto_detect then
 				Known_Boards.each do |name, data|
 					if name =~ identifier then
 						@type, @version = *identifier.split
 						@type = @type.to_sym
-						@known_board = data
+						@constructor = data[:constructor]
+						@features = data[:features]
 						break
 					end
 				end
@@ -162,7 +169,7 @@ module BitWizard
 				Known_Boards.each do |name, data|
 					if name =~ identifier then
 						@version = identifier.split[1]
-						@known_board = data
+						@features = data[:features]
 						raise ArgumentError.new "Board reports type #{real_name}, which does not match #{@type}" unless found_board[:data] == data
 						break
 					end
@@ -184,6 +191,7 @@ module BitWizard
 			data = PiPiper::Spi.begin do |spi|
 				spi.write @address | 1, reg, *Array.new(count, 0)
 			end[2..-1]
+			
 			@logger.debug("SPI [0x#{@address.to_s(16)}] --> 0x#{reg.to_s(16)}: #{data.pack("C*").inspect}")
 			data
 		end
@@ -192,16 +200,20 @@ module BitWizard
 			@logger.debug("I2C [0x#{@address.to_s(16)}] <-- 0x#{reg.to_s(16)}: #{value.is_a? Array and value.pack("C*").inspect or value.inspect}")
 			PiPiper::I2C.begin do |i2c|
 				data = [reg]
+
 				data << value unless value.is_a? Array
 				data += value if value.is_a? Array
 
-				i2c.write({ :to => @address, :data => data })
+				i2c.write({ to: @address, data: data })
 			end
 		end
 
 		def i2c_read(reg, count)
+			PiPiper::I2C.begin do |i2c|
+				i2c.write({ to: @address | 1, data: [reg] })
+			end
 			data = PiPiper::I2C.begin do |i2c|
-				i2c.write({ :to => @address | 1, :data => [reg, *Array.new(count, 0)] })
+				PiPiper::Platform.driver.i2c_set_address(@address | 1)
 				i2c.read count
 			end
 			@logger.debug("I2C [0x#{@address.to_s(16)}] --> 0x#{reg.to_s(16)}: #{data.pack("C*").inspect}")

data/lib/bitwizard/motor.rb

@@ -8,10 +8,10 @@ module BitWizard
 			# @param [optional, Hash] options A Hash of options.
 			def initialize(options={})
 				options = {
-					:bus => :spi
+					bus: :spi
 				}.merge(options)
 				options = options.merge({
-					:type => "#{options[:bus]}_motor".to_sym,
+					type: "#{options[:bus]}_motor".to_sym,
 				})
 
 				super(options)
@@ -147,9 +147,9 @@ module BitWizard
 	end
 
 	Known_Boards[/(spi|i2c)_motor/] = {
-		:default_address => 0x90,
-		:constructor => Proc.new { |options| BitWizard::Boards::Motor.new options },
-		:features => [ :motor, :stepper, :pwm ]
+		default_address: 0x90,
+		constructor: Proc.new { |options| BitWizard::Boards::Motor.new options },
+		features: [ :motor, :stepper, :pwm ]
 	}
 
 end

data/lib/bitwizard/nfets.rb

@@ -11,11 +11,11 @@ module BitWizard
 			# @option options [Number] :num The number of FETs on the board (3 or 7)
 			def initialize(options={})
 				options = {
-					:num => 3,
-					:bus => :spi
+					num: 3,
+					bus: :spi
 				}.merge(options)
 				options = options.merge({
-					:type => "#{options[:bus]}_#{options[:num]}fets".to_sym,
+					type: "#{options[:bus]}_#{options[:num]}fets".to_sym,
 				})
 
 				raise ArgumentError.new "Number of FETs must be 3 or 7" unless options[:num] == 3 or options[:num] == 7
@@ -173,14 +173,14 @@ module BitWizard
 	end
 
 	Known_Boards[/(spi|i2c)_3fets/] = {
-		:default_address => 0x8a,
-		:constructor => Proc.new { |options| BitWizard::Boards::FETs.new options.merge({ :num => 3 }) },
-		:features => [ :input, :output, :stepper, :pwm ]
+		default_address: 0x8a,
+		constructor: Proc.new { |options| BitWizard::Boards::FETs.new options.merge({ num: 3 }) },
+		features: [ :input, :output, :stepper, :pwm ]
 	}
 	Known_Boards[/(spi|i2c)_7fets/] = {
-		:default_address => 0x88,
-		:constructor => Proc.new { |options| BitWizard::Boards::FETs.new options.merge({ :num => 7 }) },
-		:features => [ :input, :output, :stepper, :pwm ]
+		default_address: 0x88,
+		constructor: Proc.new { |options| BitWizard::Boards::FETs.new options.merge({ num: 7 }) },
+		features: [ :input, :output, :stepper, :pwm ]
 	}
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitwizard
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alexander "Ace" Olofsson