Module: NatureRemo::Endpoints::Signals

Included in:
NatureRemo::Endpoints
Defined in:
lib/nature_remo/endpoints/signals.rb

Overview

Endpoints for user infomation

Instance Method Summary collapse

Instance Method Details

#create_signal(appliance_id:, name:, image:, message:) ⇒ String

Create a signal under this appliance. swagger.nature.global/#/default/post_1_appliances__appliance__signals

Parameters:

  • appliance_id (String) —

    Appliance ID.

  • message (String) —

    JSON serialized object describing infrared signals. Includes “data”, “freq” and “format” keys.

  • image (String) —

    Basename of the image file included in the app. Ex: “ico_io”

  • name (String) —

    Signal name

Returns:

  • (String) —

    Created signal

Raises:



26
27
28
29
30
31
32
33
34
 
# File 'lib/nature_remo/endpoints/signals.rb', line 26

def create_signal(appliance_id:, name:, image:, message:)
  params = {
    name: name,
    image: image,
    message: message
  }

  post("appliances/#{appliance_id}/signals", params)
end

#delete_signal(signal_id:) ⇒ String

Delete an infrared signal. swagger.nature.global/#/default/post_1_signals__signal__delete

Parameters:

  • signal_id (String) —

    Signal ID.

Returns:

  • (String) —

    Deleted a signal

Raises:



65
66
67
 
# File 'lib/nature_remo/endpoints/signals.rb', line 65

def delete_signal(signal_id:)
  post("signals/#{signal_id}/delete")
end

#send_signal(signal_id:) ⇒ String

Send infrared signal. swagger.nature.global/#/default/post_1_signals__signal__send

Parameters:

  • signal_id (String) —

    Signal ID.

Returns:

  • (String) —

    Successfully sent infrared signal

Raises:



75
76
77
 
# File 'lib/nature_remo/endpoints/signals.rb', line 75

def send_signal(signal_id:)
  post("signals/#{signal_id}/send")
end

#signals(appliance_id:) ⇒ String

Fetch signals registered under this appliance. swagger.nature.global/#/default/get_1_appliances__appliance__signals

Parameters:

  • appliance_id (String) —

    Appliance ID.

Returns:

  • (String) —

    List of signals

Raises:



13
14
15
 
# File 'lib/nature_remo/endpoints/signals.rb', line 13

def signals(appliance_id:)
  get("appliances/#{appliance_id}/signals")
end

#update_signal(signal_id:, name:, image:) ⇒ String

Update infrared signal. swagger.nature.global/#/default/post_1_signals_signal

Parameters:

  • signal_id (String) —

    Signal ID.

  • image (String) —

    Basename of the image file included in the app. Ex: “ico_io”

  • name (String) —

    Signal name

Returns:

  • (String) —

    Updated infrared signal

Raises:



55
56
57
 
# File 'lib/nature_remo/endpoints/signals.rb', line 55

def update_signal(signal_id:, name:, image:)
  post("signals/#{signal_id}", { name: name, image: image })
end

#update_signal_orders(appliance_id:, signal_ids:) ⇒ String

Reorder signals under this appliance. swagger.nature.global/#/default/post_1_appliances__appliance__signal_orders

Parameters:

  • appliance_id (String) —

    Appliance ID.

Returns:

  • (String) —

    Reordered signals

Raises:



43
44
45
 
# File 'lib/nature_remo/endpoints/signals.rb', line 43

def update_signal_orders(appliance_id:, signal_ids:)
  post("appliances/#{appliance_id}/signal_orders", { signals: signal_ids })
end