diff --git a/docs/genindex.html b/docs/genindex.html index 244ab90f..177cc14a 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -95,6 +95,8 @@
Wrapper for frequently used mapping files.
+Loads the given yaml file and returns the data.
+filepath – YAML filepath to load.
default – Default value if loading failed or file missing.
loader – YAML loader object.
Returns the YAML data as a list or dict.
+List[Any] | Dict[str, Any]
+Dumps the data into the given yaml filepath.
+filepath – Filepath to dump.
data – Data to dump.
indent – Indentation to maintain.
sort_keys – Boolean flag to sort the keys.
Add a particular secure key dictionary to the mapping file.
Dumps the reminder data into the respective yaml file.
Dumps the alarm data into the respective yaml file.
Get IP information from a stored yaml file.
+Returns the public IP info.
+Dict[str, Any]
+Store IP address information in a mapping file.
+data – Data to store.
+Check if IP address is a valid IPv5 notation.
+ip_addr – IP address as string.
+Returns a boolean flag to indicate validity.
+bool
+Retrieves public IP address from various sources.
+Retrieved public IP address.
+str
+Retrieve IP information and store it in YAML mapping.
+url – URL to request IP data from.
ip_addr – IP address retrieved.
Public IP information.
+Dict[str, str]
+Public IP information.
dict
+Dict[str, str]