Behaviours: supervisor_bridge.
application_run_context() = otp_utils:application_run_context()
attribute_entry() = {attribute_name(), attribute_value()}
attribute_name() = wooper:attribute_name()
attribute_value() = wooper:attribute_value()
bin_directory_path() = file_utils:bin_directory_path()
classname() = wooper:classname()
eurid() = oceanic:eurid()
general_main_settings() = #general_main_settings{}
home_automation_settings() = {maybe(user_server_location()), BinAppBaseDirectoryPath::bin_directory_path(), MaybePscSwitchEurid::maybe(eurid()), oceanic_settings()}
Settings gathered on behalf of the home automation server.
instance_pid() = pid()
method_argument() = wooper:method_argument()
method_arguments() = wooper:method_arguments()
method_internal_result() = wooper:method_internal_result()
method_name() = wooper:method_name()
oceanic_settings() = oceanic:oceanic_settings()
oneway_name() = wooper:oneway_name()
oneway_return() = wooper:oneway_return()
request_name() = wooper:request_name()
request_result() = any()
request_result(T) = wooper:request_result(T)
request_return(T) = wooper:request_return(T)
requests_outcome() = wooper:requests_outcome()
supervisor_pid() = otp_utils:supervisor_pid()
user_muted_sensor_points() = list()
A list expected to contain muted sensor measurement points, typically as read from the sensor monitoring section of the US-Main configuration.
Expected to be specified in the form [user_muted_sensor_measurements()]: UserMutedMeasurements = [ { { nct6792, isa, "0a20" }, [ "AUXTIN1" ] }, { { acpitz, acpi, "0" }, all_points } ].user_server_location() = {LatDegrees::float(), LongDegrees::float()}
Checked more precisely as a position() in the home automation server.
addKeyValueToAttribute(State::wooper:state(), AttributeName::attribute_name(), Key::table:key(), Value::table:value()) -> wooper:state()
addToAttribute(State::wooper:state(), AttributeName::attribute_name(), Value::attribute_value()) -> wooper:state()
appendToAttribute(State::wooper:state(), AttributeName::attribute_name(), Element::attribute_value()) -> wooper:state()
concatToAttribute(State::wooper:state(), AttributeName::attribute_name(), List::attribute_value()) -> wooper:state()
decrementAttribute(State::wooper:state(), AttributeName::attribute_name()) -> wooper:state()
deleteFromAttribute(State::wooper:state(), AttributeName::attribute_name(), Element::attribute_value()) -> wooper:state()
executeConstOneway(State::wooper:state(), OnewayAtom::oneway_name()) -> void()
executeConstOneway(State::wooper:state(), OnewayAtom::oneway_name(), ArgumentList::method_arguments()) -> void()
executeConstOnewayAs(State::wooper:state(), Classname::classname(), OnewayAtom::oneway_name()) -> void()
executeConstOnewayAs(State::wooper:state(), Classname::classname(), OnewayAtom::oneway_name(), ArgumentList::method_arguments()) -> void()
executeConstRequest(State::wooper:state(), RequestAtom::request_name()) -> method_internal_result()
executeConstRequest(State::wooper:state(), RequestAtom::request_name(), ArgumentList::method_arguments()) -> method_internal_result()
executeConstRequestAs(State::wooper:state(), ParentClassname::classname(), RequestAtom::request_name()) -> method_internal_result()
executeConstRequestAs(State::wooper:state(), Classname::classname(), RequestAtom::request_name(), ArgumentList::method_arguments()) -> method_internal_result()
executeOneway(State::wooper:state(), OnewayAtom::oneway_name()) -> wooper:state()
executeOneway(State::wooper:state(), OnewayAtom::oneway_name(), ArgumentList::method_arguments()) -> wooper:state()
executeOnewayAs(State::wooper:state(), ParentClassname::classname(), OnewayAtom::oneway_name()) -> wooper:state()
executeOnewayAs(State::wooper:state(), Classname::classname(), OnewayAtom::oneway_name(), ArgumentList::method_arguments()) -> wooper:state()
executeRequest(State::wooper:state(), RequestAtom::request_name()) -> {wooper:state(), method_internal_result()}
executeRequest(State::wooper:state(), RequestAtom::request_name(), ArgumentList::method_arguments()) -> {wooper:state(), method_internal_result()}
executeRequestAs(State::wooper:state(), ParentClassname::classname(), RequestAtom::request_name()) -> {wooper:state(), method_internal_result()}
executeRequestAs(State::wooper:state(), Classname::classname(), RequestAtom::request_name(), ArgumentList::method_arguments()) -> {wooper:state(), method_internal_result()}
getAttribute(State::wooper:state(), AttributeName::attribute_name()) -> attribute_value()
getAttributes(State::wooper:state(), AttributeNameList::[attribute_name()]) -> [attribute_value()]
getMaybeAttribute(State::wooper:state(), AttributeName::attribute_name()) -> maybe(attribute_value())
get_execution_target() -> development
hasAttribute(State::wooper:state(), AttributeName::attribute_name()) -> boolean()
incrementAttribute(State::wooper:state(), AttributeName::attribute_name()) -> wooper:state()
init(Args::list()) -> {ok, pid(), State::term()} | ignore | {error, Error::term()}
Callback to initialise this supervisor bridge, typically in answer to start_link/2 above being executed.
is_wooper_debug() -> boolean()
popFromAttribute(State::wooper:state(), AttributeName::attribute_name()) -> {wooper:state(), attribute_value()}
removeAttribute(State::wooper:state(), AttributeName::attribute_name()) -> wooper:state()
setAttribute(State::wooper:state(), AttributeName::attribute_name(), AttributeValue::attribute_value()) -> wooper:state()
setAttributes(State::wooper:state(), ListOfAttributePairs::[attribute_entry()]) -> wooper:state()
start_link(SupervisorPid::supervisor_pid(), AppRunContext::application_run_context()) -> term()
Starts and links a supervision bridge for the US-Main configuration server.
Note: typically spawned as a supervised child of the US-Main root supervisor (see us_main_sup:init/1), hence generally triggered by the application initialisation.subtractFromAttribute(State::wooper:state(), AttributeName::attribute_name(), Value::attribute_value()) -> wooper:state()
swapInAttribute(State::wooper:state(), AttributeName::attribute_name(), NewAttributeValue::attribute_value()) -> {wooper:state(), attribute_value()}
terminate(Reason::shutdown | term(), State::term()) -> void()
Callback to terminate this supervisor bridge.
toggleAttribute(State::wooper:state(), BooleanAttributeName::attribute_name()) -> wooper:state()
wooper_destruct(State::wooper:state()) -> wooper:state()
wooper_effective_method_execution(SelectedModule::module(), MethodAtom::method_name(), State::wooper:state(), Parameters::method_arguments()) -> {wooper:state(), method_internal_result()}
wooper_execute_method(MethodAtom::method_name(), Parameters::method_arguments(), State::wooper:state()) -> {wooper:state(), method_internal_result()}
wooper_execute_method_as(ParentClassname::classname(), MethodAtom::method_name(), Parameters::method_arguments(), State::wooper:state()) -> {wooper:state(), method_internal_result()}
wooper_get_class_specific_attributes() -> [wooper_info:attribute_spec()]
wooper_handle_local_oneway_execution(OnewayAtom::method_name(), State::wooper:state(), ArgumentList::method_arguments()) -> wooper:state()
wooper_handle_local_request_execution(RequestAtom::method_name(), State::wooper:state(), ArgumentList::method_arguments()) -> {wooper:state(), method_internal_result()}
wooper_handle_remote_oneway_execution(OnewayAtom::method_name(), State::wooper:state(), ArgumentList::method_arguments()) -> wooper:state()
wooper_handle_remote_request_execution(RequestAtom::method_name(), State::wooper:state(), ArgumentList::method_arguments(), CallerPid::pid()) -> wooper:state()
wooper_main_loop(State::wooper:state()) -> deleted
Generated by EDoc