Module: BLE::CharRegistry
- Included in:
- Characteristic
- Defined in:
- lib/ble/char_registry.rb
Class Method Summary collapse
Class Method Details
.included(klass) ⇒ Object
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'lib/ble/char_registry.rb', line 29 def self.included(klass) class << klass # Get characteristic description from nickname. # # @param id [Symbol] nickname # @return [CharDesc] characteristic description def by_nickname(id) DB_NICKNAME[id] end # Get characteristic description from uuid. # # @param id [String] uuid # @return [CharDesc] characteristic description def by_uuid(id) DB_UUID[id] end # Get characteristic description from type # # @param id [Strig] type # @return [CharDesc] characteristic description def by_type(id) DB_TYPE[id] end # Get a characteristic description from it's id # @param id [Symbol,String] # @return [CharDesc] def [](id) case id when Symbol then DB_NICKNAME[id] when UUID::REGEX then DB_UUID[id] when String then DB_TYPE[id] when Integer then DB_UUID[BLE::UUID(id)] else raise ArgumentError, "invalid type for characteristic id" end end # Add a characteristic description. # @example Add a characteristic description with a 16-bit uuid # module Characteristic # add 0x2A6E, # name: 'Temperature', # type: 'org.bluetooth.characteristic.temperature', # vrfy: ->(x) { (0..100).include?(x) }, # in: ->(s) { s.unpack('s<').first.to_f / 100 }, # out: ->(v) { [ v*100 ].pack('s<') } # end # # @example Add a characteristic description with a 128-bit uuid # module Characteristic # add 'c4935338-4307-47cf-ae1f-feac9e2b3ae7', # name: 'Controlled mind', # type: 'net.cortex-minus.characteristic.controlled_mind', # vrfy: ->(x) { x >= 0 }, # in: ->(s) { s.unpack('s<').first }, # out: ->(v) { [ v ].pack('s<') } # end # # @param uuid [Integer, String] 16-bit, 32-bit or 128-bit uuid # @param name [String] # @option opts :type [String] type # @option opts :nick [Symbol] nickname # @option opts :in [Proc] convert to ruby # @option opts :out [Proc] convert to bluetooth data # @option opts :vry [Proc] verify # @return [CharDesc] characteristic description def add(uuid, name:, **opts) uuid = BLE::UUID(uuid) type = opts.delete :type nick = opts.delete :nick _in = opts.delete :in _out = opts.delete :out vrfy = opts.delete :vrfy if opts.first raise ArgumentError, "unknown keyword: #{opts.first[0]}" end char_config= DB_UUID[uuid] = { uuid: uuid, name: name, in: _in, out: _out, vrfy: vrfy } # Add type if specified if type type = type.downcase char_config.merge!(type: type) DB_TYPE[type] = char_config end # Add nickname if specified or can be derived from type if nick.nil? && type && type =~ /\.(?<key>[^.]+)$/ nick = $1.to_sym if type.start_with? 'org.bluetooth.characteristic' end if nick if DB_NICKNAME.include?(nick) raise ArgumentError, "nickname '#{nick}' already registered (uuid: #{uuid})" end DB_NICKNAME[nick] = char_config end end end end |