airthings 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3a228c29713880c209f13d44ffc0deca3e8dbf517b15ccf10e5f1631632160d
+  data.tar.gz: 4ba1f36b8848bfef3c08d17e5ea8f64f539107a65a01a0c22e56f4424055376a
+SHA512:
+  metadata.gz: e847bc6791c8b97c6bbb35967473cab6a60101bcef29444cd9675d2cca93d62093f0a191ddaff5a3df6c8f085e9eb2deb29ccee418aa06f76c57ead30b956fd9
+  data.tar.gz: 6bc7eb7ad55001a20e6a6988b58fe9e05698eb35d063aa2f8de4911f87ef2205bce6e38a9700544f25673dddbeb6d9b53ba2459617ffbb37b83954256dcf8929

data/exe/airthings_mqtt_bridge

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "airthings"
+require "airthings/oauth2"
+require "homie-mqtt"
+require "optparse"
+
+refresh = 60.0
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: airthings_mqtt_bridge ID SECRET MQTT_URI [options]"
+
+  opts.on("--refresh-interval=INTERVAL", "Refresh interval (default 60s)") { |v| refresh = v.to_f }
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+options.parse!
+
+unless ARGV.length == 3
+  puts options
+  exit 1
+end
+
+Airthings.configure do |config|
+  config.id = ARGV[0]
+  config.secret = ARGV[1]
+end
+
+api_instance = Airthings::DevicesApi.new
+
+homie = MQTT::Homie::Device.new("airthings", "Airthings Devices", mqtt: { uri: ARGV[2], reconnect_limit: 3 })
+
+INVERTED_ATTRIBUTE_MAP = Airthings::SingleSampleData.attribute_map.invert.freeze
+ATTRIBUTE_UNITS = {
+  battery: "%",
+  co2: "ppm",
+  humidity: "%",
+  pressure: "mbar",
+  radon_short_term_avg: "mBq",
+  rssi: "dB",
+  temp: "°C",
+  voc: "ppb",
+  outdoor_temp: "°C",
+  outdoor_humidity: "%",
+  outdoor_pressure: "mbar"
+}.freeze
+
+devices = api_instance.devices_list.devices
+devices.each do |device|
+  next if device.sensors.empty?
+
+  samples = api_instance.device_samples_latest_values(device.id).data
+  node = homie.node(device.id, device.device_type, device.device_type)
+  device.sensors.each do |sensor|
+    method = INVERTED_ATTRIBUTE_MAP[sensor.to_sym]
+    value = samples.send(method)
+    node.property(method.to_s.tr("_", "-"), sensor, value.class.name.downcase.to_sym, value,
+                  unit: ATTRIBUTE_UNITS[method])
+  end
+end
+
+homie.publish
+
+loop do
+  devices.each do |device|
+    next if device.sensors.empty?
+
+    samples = api_instance.device_samples_latest_values(device.id).data
+    homie.mqtt.batch_publish do
+      node = homie[device.id]
+      device.sensors.each do |sensor|
+        method = INVERTED_ATTRIBUTE_MAP[sensor.to_sym]
+        property = node[method.to_s.tr("_", "-")]
+        property.value = samples.send(method)
+      end
+    end
+  end
+
+  sleep refresh
+end

data/lib/airthings/api/devices_api.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+# #Airthings API
+#
+# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#
+# The version of the OpenAPI document: v1
+#
+# Generated by: https://openapi-generator.tech
+# OpenAPI Generator version: 6.2.0
+#
+
+require "cgi"
+
+module Airthings
+  class DevicesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get info about a specific Device
+    # @param serial_number [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [GetDeviceDetailedResponse]
+    def device_info(serial_number, opts = {})
+      data, _status_code, _headers = device_info_with_http_info(serial_number, opts)
+      data
+    end
+
+    # Get info about a specific Device
+    # @param serial_number [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [Array<(GetDeviceDetailedResponse, Integer, Hash)>] GetDeviceDetailedResponse data, response status code and response headers
+    def device_info_with_http_info(serial_number, opts = {})
+      @api_client.config.logger.debug "Calling API: DevicesApi.device_info ..." if @api_client.config.debugging
+      # verify the required parameter 'serial_number' is set
+      if @api_client.config.client_side_validation && serial_number.nil?
+        raise ArgumentError, "Missing the required parameter 'serial_number' when calling DevicesApi.device_info"
+      end
+
+      # resource path
+      local_var_path = "/devices/{serialNumber}".sub("{serialNumber}", CGI.escape(serial_number.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:organizationId] = opts[:organization_id] unless opts[:organization_id].nil?
+      query_params[:userGroupId] = opts[:user_group_id] unless opts[:user_group_id].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "GetDeviceDetailedResponse"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["AirthingsAccounts"]
+
+      new_options = opts.merge(
+        operation: :"DevicesApi.device_info",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DevicesApi#device_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Get latest Samples belonging to a specific Device (latest segment)
+    # @param serial_number [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [SingleSampleResponse]
+    def device_samples_latest_values(serial_number, opts = {})
+      data, _status_code, _headers = device_samples_latest_values_with_http_info(serial_number, opts)
+      data
+    end
+
+    # Get latest Samples belonging to a specific Device (latest segment)
+    # @param serial_number [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [Array<(SingleSampleResponse, Integer, Hash)>] SingleSampleResponse data, response status code and response headers
+    def device_samples_latest_values_with_http_info(serial_number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DevicesApi.device_samples_latest_values ..."
+      end
+      # verify the required parameter 'serial_number' is set
+      if @api_client.config.client_side_validation && serial_number.nil?
+        raise ArgumentError, "Missing the required parameter 'serial_number' when calling DevicesApi.device_samples_latest_values"
+      end
+
+      # resource path
+      local_var_path = "/devices/{serialNumber}/latest-samples".sub("{serialNumber}", CGI.escape(serial_number.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:organizationId] = opts[:organization_id] unless opts[:organization_id].nil?
+      query_params[:userGroupId] = opts[:user_group_id] unless opts[:user_group_id].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "SingleSampleResponse"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["AirthingsAccounts"]
+
+      new_options = opts.merge(
+        operation: :"DevicesApi.device_samples_latest_values",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DevicesApi#device_samples_latest_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Get Devices belonging to the Account
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :show_inactive  (default to false)
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [GetDevicesResponse]
+    def devices_list(opts = {})
+      data, _status_code, _headers = devices_list_with_http_info(opts)
+      data
+    end
+
+    # Get Devices belonging to the Account
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :show_inactive  (default to false)
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [Array<(GetDevicesResponse, Integer, Hash)>] GetDevicesResponse data, response status code and response headers
+    def devices_list_with_http_info(opts = {})
+      @api_client.config.logger.debug "Calling API: DevicesApi.devices_list ..." if @api_client.config.debugging
+      # resource path
+      local_var_path = "/devices"
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:showInactive] = opts[:show_inactive] unless opts[:show_inactive].nil?
+      query_params[:organizationId] = opts[:organization_id] unless opts[:organization_id].nil?
+      query_params[:userGroupId] = opts[:user_group_id] unless opts[:user_group_id].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "GetDevicesResponse"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["AirthingsAccounts"]
+
+      new_options = opts.merge(
+        operation: :"DevicesApi.devices_list",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DevicesApi#devices_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+  end
+end

data/lib/airthings/api/locations_api.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# #Airthings API
+#
+# No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#
+# The version of the OpenAPI document: v1
+#
+# Generated by: https://openapi-generator.tech
+# OpenAPI Generator version: 6.2.0
+#
+
+require "cgi"
+
+module Airthings
+  class LocationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get info about a specific Location
+    # @param location_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :show_inactive  (default to false)
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [GetLocationResponse]
+    def location_info(location_id, opts = {})
+      data, _status_code, _headers = location_info_with_http_info(location_id, opts)
+      data
+    end
+
+    # Get info about a specific Location
+    # @param location_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :show_inactive  (default to false)
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [Array<(GetLocationResponse, Integer, Hash)>] GetLocationResponse data, response status code and response headers
+    def location_info_with_http_info(location_id, opts = {})
+      @api_client.config.logger.debug "Calling API: LocationsApi.location_info ..." if @api_client.config.debugging
+      # verify the required parameter 'location_id' is set
+      if @api_client.config.client_side_validation && location_id.nil?
+        raise ArgumentError, "Missing the required parameter 'location_id' when calling LocationsApi.location_info"
+      end
+
+      # resource path
+      local_var_path = "/locations/{locationId}".sub("{locationId}", CGI.escape(location_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:showInactive] = opts[:show_inactive] unless opts[:show_inactive].nil?
+      query_params[:organizationId] = opts[:organization_id] unless opts[:organization_id].nil?
+      query_params[:userGroupId] = opts[:user_group_id] unless opts[:user_group_id].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "GetLocationResponse"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["AirthingsAccounts"]
+
+      new_options = opts.merge(
+        operation: :"LocationsApi.location_info",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#location_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Get all added Locations
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [GetLocationsResponse]
+    def locations_list(opts = {})
+      data, _status_code, _headers = locations_list_with_http_info(opts)
+      data
+    end
+
+    # Get all added Locations
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id
+    # @option opts [String] :user_group_id
+    # @return [Array<(GetLocationsResponse, Integer, Hash)>] GetLocationsResponse data, response status code and response headers
+    def locations_list_with_http_info(opts = {})
+      @api_client.config.logger.debug "Calling API: LocationsApi.locations_list ..." if @api_client.config.debugging
+      # resource path
+      local_var_path = "/locations"
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:organizationId] = opts[:organization_id] unless opts[:organization_id].nil?
+      query_params[:userGroupId] = opts[:user_group_id] unless opts[:user_group_id].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params["Accept"] = @api_client.select_header_accept(["application/json"])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || "GetLocationsResponse"
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ["AirthingsAccounts"]
+
+      new_options = opts.merge(
+        operation: :"LocationsApi.locations_list",
+        header_params: header_params,
+        query_params: query_params,
+        form_params: form_params,
+        body: post_body,
+        auth_names: auth_names,
+        return_type: return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationsApi#locations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+  end
+end