Categorygithub.com/MikMuellerDev/smarthome_sdk
modulepackage
0.4.0
Repository: https://github.com/mikmuellerdev/smarthome_sdk.git
Documentation: pkg.go.dev

# README

smarthome-sdk

A go package which makes communication to a smarthome server simple

# Functions

Creates a new connection First argument specifies the base URL of the target Smarthome-server Second argument specifies how to handle authentication.

# Constants

* Cookie authentication relies on a cookie-store which sends a authentication cookie at every request - Faster response-time: The server does not need to revalidate the user's credentials on every request - Static: If the Smarthome server is restarted, the stored cookie becomes invalid and the communication breaks - Not recommended for long-running applications */.
* No authentication will send every request without any form of user-authentication - Can be used in a context which does not require authentication, for example, listing the switches - Not reccomended in most cases due to the strict data protection of Smarthome */.
* URL-query authentication adds `?username=foo&password=bar` to every requested URL - Slower response-time: The server needs to revalidate the user's credentials on every request - Dynamic: The connection will remain in a working condition after the smarthome server has been restarted - Recommended for long-running applications */.
No description provided by the author
No description provided by the author
Post
No description provided by the author
No description provided by the author
The database connection has failed, Smarthome cannot be used in this state.
All systems are in a operational state.
Some systems are degraded, for example one out of more Hardware nodes have failed recently.
Default return value if a request error occurs.
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
Is returned when the debug information is requested.
Specifies where the Homescript error occurred.
Represents a Homescript entity.
Contains information about why a Homescript terminated.
Used for creating a new script or modifying an existing one.
Under normal conditions, Smarthome will return such a response.
No description provided by the author
No description provided by the author
Switch Response from Smarthome Id is a unique identifier used for many actions regarding switches.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author