MqttApiClient

Ruby gem that enables sending commands to MQTT clients. The gem should support secure connections to the MQTT broker using SSL.

Installation

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

$ bundle add mqtt_api_client

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install mqtt_api_client

Usage

#
# connect to your MQTT broker (AWS IoT, Mosquitto, and so on..)
# @param [String], crt
# @param [String], key
# @param [String], host
mqtt_client = MQTT::Client.new.tap do |client|
  # connection info
  client.host = "my.host"
  client.port = 8883
  client.ssl = true

  # certificates
  client.cert = my_cert
  client.key = my_private_key

  client.connect
end

#
# @param [MQTT::Client], mqtt_client
# @param [String], device_identifier
command = MqttApiClient::Command.new(mqtt_client, "D0045F")

command.health_status
command.file_list

command.disconnect

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/macklabsinc/mqtt_api_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the MqttApiClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.