class Cisco::RoomKit
- Cisco::RoomKit
- PlaceOS::Driver
- Reference
- Object
Included Modules
- Cisco::CollaborationEndpoint
- Cisco::CollaborationEndpoint::Cameras
- Cisco::CollaborationEndpoint::Powerable
- Cisco::CollaborationEndpoint::Presentation
- Cisco::CollaborationEndpoint::UIExtensions
- PlaceOS::Driver::Interface::Sensor
Defined in:
cisco/room_kit.crConstant Summary
-
NO_MATCH =
[] of Interface::Sensor::Detail -
SENSOR_TYPES =
{SensorType::PeopleCount, SensorType::Presence}
Class Method Summary
Instance Method Summary
- #autofocus_diagnostics_start(camera_id : Int32)
- #autofocus_diagnostics_stop(camera_id : Int32)
- #bookings(days : Int32 | Nil = nil, day_offset : Int32 | Nil = nil, limit : Int32 | Nil = nil, offset : Int32 | Nil = nil)
- #call_accept(call_id : Int32 | Nil = nil)
- #call_place_on_hold(call_id : Int32 | Nil = nil)
- #call_reject(call_id : Int32 | Nil = nil)
- #call_resume(call_id : Int32 | Nil = nil)
- #camera_select(connector_id : Int32 | Nil = nil, layout : VideoLayout | Nil = nil, source_id : Int32 | Nil = nil)
- #connected
- #dial(number : String, protocol : DialProtocol | Nil = nil, call_rate : Int32 | Nil = nil, call_type : CallType | Nil = nil)
- #dtmf_send(d_t_m_f_string : String, call_id : Int32 | Nil = nil)
- #hangup(call_id : Int32 | Nil = nil)
- #mic_mute(state : Bool = true)
- #mic_mute_off
- #mic_mute_on
- #mic_mute_toggle
- #phonebook_search(search_string : String, phonebook_type : PhonebookType | Nil = nil, limit : Int32 | Nil = nil, offset : Int32 | Nil = nil)
- #play_sound(sound : Sound, loop : Toogle | Nil = nil)
- #presentation_mode(value : PresentationMode)
- #reboot(action : PowerOff | Nil = nil)
- #selfview(mode : Toogle | Nil = nil, full_screen_mode : Toogle | Nil = nil, p_i_p_position : PiPPosition | Nil = nil, on_monitor_role : MonitorRole | Nil = nil)
-
#sensor(mac : String, id : String | Nil = nil) : Interface::Sensor::Detail | Nil
return the specified sensor details
-
#sensors(type : String | Nil = nil, mac : String | Nil = nil, zone_id : String | Nil = nil) : Array(Interface::Sensor::Detail)
return an array of sensor details zone_id can be ignored if location is unknown by the sensor provider mac_address can be used to grab data from a single device (basic grouping)
- #show_camera_pip(visible : Bool)
- #speaker_track(state : Bool = true)
- #speaker_track_activate
- #speaker_track_deactivate
- #speaker_track_diagnostics_start
- #speaker_track_diagnostics_stop
- #stop_sound
- #video_layout(layout_family : LayoutFamily, target : LayoutTarget | Nil = nil)
- #webview_clear
- #webview_display(url : String)
Instance methods inherited from module Cisco::CollaborationEndpoint::Cameras
camera_move(camera_id : Int32, pan : Interface::Camera::PanDirection | Nil = nil, pan_speed : Int32 | Nil = nil, tilt : Interface::Camera::TiltDirection | Nil = nil, tilt_speed : Int32 | Nil = nil, zoom : Interface::Zoomable::ZoomDirection | Nil = nil, zoom_speed : Int32 | Nil = nil, focus : FocusDirection | Nil = nil)
camera_move,
camera_position_reset(camera_id : Int32, axis : CameraAxis | Nil = nil)
camera_position_reset,
camera_preset(preset_id : Int32)
camera_preset,
camera_remove_preset(preset_id : Int32)
camera_remove_preset,
camera_store_preset(camera_id : Int32, preset_id : Int32, name : String | Nil = nil, take_snapshot : Bool | Nil = nil, default_position : Bool | Nil = nil)
camera_store_preset,
joystick(pan_speed : Float64, tilt_speed : Float64, index : Int32 | String = 0)
joystick,
move(position : MoveablePosition, index : Int32 | String = 0)
move,
recall(position : String, index : Int32 | String = 0)
recall,
remove_position(name : String, index : Int32 | String = 0)
remove_position,
save_position(name : String, index : Int32 | String = 0)
save_position,
stop(index : Int32 | String = 0, emergency : Bool = false)
stop,
zoom(direction : ZoomDirection, index : Int32 | String = 0)
zoom,
zoom_to(position : Float64, auto_focus : Bool = true, index : Int32 | String = 0)
zoom_to
Class methods inherited from module Cisco::CollaborationEndpoint::XAPI
create_action(__action__ : ActionType, *args, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, priority : Int32 | Nil = nil, **kwargs)
create_action,
parse(data : String)
parse,
tokenize(path : String)
tokenize,
value_convert(value : String, valuespace : String | Nil = nil)
value_convert,
xcommand(path : String, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, **kwargs)
xcommand,
xconfiguration(path : String, setting : String, value : JSON::Any::Type)
xconfiguration,
xfeedback(action : FeedbackAction, path : String | Nil = nil)
xfeedback,
xstatus(path : String)
xstatus
Macros inherited from module Cisco::CollaborationEndpoint::XAPI
command(cmd_name, **params)
command
Instance methods inherited from module Cisco::CollaborationEndpoint::Powerable
half_wake
half_wake,
power(state : Bool)
power,
power_state(state : Interface::Powerable::PowerState)
power_state,
powerup
powerup,
reset_standby_timer(delay : Int32)
reset_standby_timer,
standby
standby
Class methods inherited from module Cisco::CollaborationEndpoint::XAPI
create_action(__action__ : ActionType, *args, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, priority : Int32 | Nil = nil, **kwargs)
create_action,
parse(data : String)
parse,
tokenize(path : String)
tokenize,
value_convert(value : String, valuespace : String | Nil = nil)
value_convert,
xcommand(path : String, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, **kwargs)
xcommand,
xconfiguration(path : String, setting : String, value : JSON::Any::Type)
xconfiguration,
xfeedback(action : FeedbackAction, path : String | Nil = nil)
xfeedback,
xstatus(path : String)
xstatus
Macros inherited from module Cisco::CollaborationEndpoint::XAPI
command(cmd_name, **params)
command
Instance methods inherited from module Cisco::CollaborationEndpoint::Presentation
presentation_start(presentation_source : Int32 | Nil = nil, sending_mode : SendingMode | Nil = nil, connector_id : Int32 | Nil = nil, instance : Int32 | Nil = nil)
presentation_start,
presentation_stop(instance : Int32 | Nil = nil, presentation_source : Int32 | Nil = nil)
presentation_stop,
send_presentation_to(remote : Bool)
send_presentation_to,
switch_to(input : PresentationInputs)
switch_to
Class methods inherited from module Cisco::CollaborationEndpoint::XAPI
create_action(__action__ : ActionType, *args, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, priority : Int32 | Nil = nil, **kwargs)
create_action,
parse(data : String)
parse,
tokenize(path : String)
tokenize,
value_convert(value : String, valuespace : String | Nil = nil)
value_convert,
xcommand(path : String, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, **kwargs)
xcommand,
xconfiguration(path : String, setting : String, value : JSON::Any::Type)
xconfiguration,
xfeedback(action : FeedbackAction, path : String | Nil = nil)
xfeedback,
xstatus(path : String)
xstatus
Macros inherited from module Cisco::CollaborationEndpoint::XAPI
command(cmd_name, **params)
command
Instance methods inherited from module Cisco::CollaborationEndpoint::UIExtensions
msg_alert(text : String, title : String | Nil = nil, duration : Int32 | Nil = nil)
msg_alert,
msg_alert_clear
msg_alert_clear,
msg_prompt(text : String, options : Array(JSON::Any::Type), title : String | Nil = nil, feedback_id : String | Nil = nil, duration : Int64 | Nil = nil)
msg_prompt,
msg_prompt_clear
msg_prompt_clear,
msg_text(text : String, feedback_id : String, title : String | Nil = nil, duration : Int32 | Nil = nil, input_type : TextInputType | Nil = nil, keyboard_state : TextKeyboardState | Nil = nil, place_holder : String | Nil = nil, submit_text : String | Nil = nil)
msg_text,
msg_text_clear
msg_text_clear,
ui_extensions_clear
ui_extensions_clear,
ui_extensions_deploy(id : String, xml_def : String)
ui_extensions_deploy,
ui_extensions_list
ui_extensions_list,
ui_set_value(widget : String, value : JSON::Any::Type | Nil = nil)
ui_set_value
Class methods inherited from module Cisco::CollaborationEndpoint::XAPI
create_action(__action__ : ActionType, *args, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, priority : Int32 | Nil = nil, **kwargs)
create_action,
parse(data : String)
parse,
tokenize(path : String)
tokenize,
value_convert(value : String, valuespace : String | Nil = nil)
value_convert,
xcommand(path : String, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, **kwargs)
xcommand,
xconfiguration(path : String, setting : String, value : JSON::Any::Type)
xconfiguration,
xfeedback(action : FeedbackAction, path : String | Nil = nil)
xfeedback,
xstatus(path : String)
xstatus
Macros inherited from module Cisco::CollaborationEndpoint::XAPI
command(cmd_name, **params)
command
Instance methods inherited from module Cisco::CollaborationEndpoint
bind_feedback(path : String, status_key : String)
bind_feedback,
bind_status(path : String, status_key : String)
bind_status,
clear_event(path : String)
clear_event,
clear_feedback_subscriptions(connected : Bool = true)
clear_feedback_subscriptions,
connected
connected,
disconnected
disconnected,
ensure_feedback_registered
ensure_feedback_registered,
feedback_paths : Array(String)
feedback_paths,
generate_request_uuid
generate_request_uuid,
on_event(path : String, mod_id : String, channel : String)
on_event,
on_load
on_load,
on_update
on_update,
peripheral_id : String
peripheral_id,
push_config
push_config,
received(data, task)
received,
register_feedback(path : String, &update_handler : Proc(String, Enumerable::JSONComplex, Nil))
register_feedback,
sync_config
sync_config,
unregister_feedback(path : String)
unregister_feedback,
xcommand(command : String, multiline_body : String | Nil = nil, hash_args : Hash(String, JSON::Any::Type) = {} of String => JSON::Any::Type, **kwargs)
xcommand,
xconfiguration(path : String, hash_args : Hash(String, JSONBasic) = {} of String => JSONBasic, **kwargs)
xconfiguration,
xconfigurations(config : Config)
xconfigurations,
xstatus(path : String)
xstatus
Class Method Detail
Instance Method Detail
def bookings(days : Int32 | Nil = nil, day_offset : Int32 | Nil = nil, limit : Int32 | Nil = nil, offset : Int32 | Nil = nil)
#
def camera_select(connector_id : Int32 | Nil = nil, layout : VideoLayout | Nil = nil, source_id : Int32 | Nil = nil)
#
def dial(number : String, protocol : DialProtocol | Nil = nil, call_rate : Int32 | Nil = nil, call_type : CallType | Nil = nil)
#
def phonebook_search(search_string : String, phonebook_type : PhonebookType | Nil = nil, limit : Int32 | Nil = nil, offset : Int32 | Nil = nil)
#
def selfview(mode : Toogle | Nil = nil, full_screen_mode : Toogle | Nil = nil, p_i_p_position : PiPPosition | Nil = nil, on_monitor_role : MonitorRole | Nil = nil)
#
def sensor(mac : String, id : String | Nil = nil) : Interface::Sensor::Detail | Nil
#
Description copied from module PlaceOS::Driver::Interface::Sensor
return the specified sensor details
def sensors(type : String | Nil = nil, mac : String | Nil = nil, zone_id : String | Nil = nil) : Array(Interface::Sensor::Detail)
#
Description copied from module PlaceOS::Driver::Interface::Sensor
return an array of sensor details zone_id can be ignored if location is unknown by the sensor provider mac_address can be used to grab data from a single device (basic grouping)