HSL 2.0 framework
Description of the framework
|
all framework functionalities More..
Public Member Functions | |
def | __init__ (self, homeserver_context, module_context, module_instance) |
Constructor. More... | |
def | get_homeserver_version (self) |
Returns the version of the firmware loaded on the machine. More... | |
def | get_homeserver_version_major (self) |
Returns the major release number of the firmware installed on the unit. More... | |
def | get_homeserver_version_minor (self) |
Returns the minor release number of the firmware installed on the unit. More... | |
def | get_homeserver_serial_id (self) |
Returns the serial number of the machine. More... | |
def | get_homeserver_private_ip (self) |
Returns the private IP address of this machine. More... | |
def | get_project_id (self) |
Returns the ID of the currently loaded project. More... | |
def | get_coordinates (self) |
Returns the coordinates given in the project for the calculation of the sun's position. More... | |
def | get_context (self) |
Returns the key of the module context. More... | |
def | get_instance_by_id (self, instance_id) |
Returns a block instance. More... | |
def | get_instance_from_module_by_id (self, module_context, instance_id) |
Returns a block instance. More... | |
def | create_http_server (self) |
Creates an instance of an HTTP server. More... | |
def | create_http_client (self) |
Creates an instance of an HTTP client. More... | |
def | create_tcp_client (self) |
Creates an instance of a TCP client. More... | |
def | create_udp_unicast (self) |
Creates an instance of a UDP unicast socket. More... | |
def | create_udp_broadcast (self) |
Creates an instance of a UDP broadcast socket. More... | |
def | create_udp_multicast (self) |
Creates an instance of a UDP multicast socket. More... | |
def | create_timer (self) |
Creates an instance of a timer. More... | |
def | create_interval (self) |
Creates an instance of an interval timer. More... | |
def | create_debug_section (self) |
Creates a section on the debug page of the HS/FS. More... | |
def | create_md5_hash (self) |
Creates an instance of the MD5 class. More... | |
def | create_sha1_hash (self) |
Creates an instance of SHA1 class. More... | |
def | create_sha224_hash (self) |
Creates an instance of the SHA2 class. More... | |
def | create_sha256_hash (self) |
Creates an instance of SHA2 class. More... | |
def | create_sha384_hash (self) |
Creates an instance of the SHA2 class. More... | |
def | create_sha512_hash (self) |
Creates an instance of the SHA2 class. More... | |
def | create_aes (self) |
Creates an instance of the AES class. More... | |
def | resolve_dns (self, host) |
Provides an IP address. More... | |
Static Public Member Functions | |
def | get_framework_index () |
Returns the version index of the framework. More... | |
Maps all framework functionalities
The class is automatically instantiated by the base module and should not be instantiated directly
def hsl20_4.hsl20_4.framework.__init__ | ( | self, | |
homeserver_context, | |||
module_context, | |||
module_instance | |||
) |
Constructor
homeserver_context | object Reference to the HomeServer object structure |
module_context | string Key of the module context |
module_instance | function Block instance |
def hsl20_4.hsl20_4.framework.create_aes | ( | self | ) |
Creates an instance of the AES class
Used to decrypt/encrypt data using AES
def hsl20_4.hsl20_4.Framework.create_debug_section | ( | self | ) |
Creates a section on the debug page of the HS/FS
def hsl20_4.hsl20_4.framework.create_http_client | ( | self | ) |
Creates an instance of an HTTP client
def hsl20_4.hsl20_4.framework.create_http_server | ( | self | ) |
Creates an instance of an HTTP server
def hsl20_4.hsl20_4.framework.create_interval | ( | self | ) |
Creates an instance of an interval timer
def hsl20_4.hsl20_4.framework.create_md5_hash | ( | self | ) |
Creates an instance of the MD5 class
Creates a 128-bit MD5 hash value
def hsl20_4.hsl20_4.framework.create_sha1_hash | ( | self | ) |
Creates an instance of SHA1 class
Used to create a 160-bit SHA1 hash value
def hsl20_4.hsl20_4.framework.create_sha224_hash | ( | self | ) |
Creates an instance of SHA2 class
Used to create a 224-bit SHA2 hash value
def hsl20_4.hsl20_4.framework.create_sha256_hash | ( | self | ) |
Creates an instance of the SHA2 class
Used to create a 256-bit SHA2 hash value
def hsl20_4.hsl20_4.framework.create_sha384_hash | ( | self | ) |
Creates an instance of the SHA2 class
Serves to create a 384 bit long SHA2 hash value
def hsl20_4.hsl20_4.framework.create_sha512_hash | ( | self | ) |
Creates an instance of the SHA2 class
Used to create 512 bit long SHA2 hash values
def hsl20_4.hsl20_4.framework.create_tcp_client | ( | self | ) |
Creates an instance of a TCP client
def hsl20_4.hsl20_4.framework.create_timer | ( | self | ) |
Creates an instance of a timer
def hsl20_4.hsl20_4.framework.create_udp_broadcast | ( | self | ) |
Creates an instance of a UDP broadcast socket
def hsl20_4.hsl20_4.framework.create_udp_multicast | ( | self | ) |
Creates an instance of a UDP multicast socket
def hsl20_4.hsl20_4.framework.create_udp_unicast | ( | self | ) |
Creates an instance of a UDP unicast socket
def hsl20_4.hsl20_4.framework.get_context | ( | self | ) |
Returns the key of the module context
def hsl20_4.hsl20_4.framework.get_coordinates | ( | self | ) |
Returns the coordinates specified in the project for the calculation of the sun's position
|
static |
Returns the version index of the framework
In this version the version index is 7
def hsl20_4.hsl20_4.framework.get_homeserver_private_ip | ( | self | ) |
Returns the private IP address of this machine
def hsl20_4.hsl20_4.framework.get_homeserver_serial_id | ( | self | ) |
Returns the serial number of the machine
def hsl20_4.hsl20_4.framework.get_homeserver_version | ( | self | ) |
Returns the version of the firmware loaded on the device
def hsl20_4.hsl20_4.framework.get_homeserver_version_major | ( | self | ) |
Returns the major release number of the firmware installed on the unit
result int Major release number of the firmware
def hsl20_4.hsl20_4.framework.get_homeserver_version_minor | ( | self | ) |
Returns the minor release number of the firmware installed on the unit
result int Minor release number of the firmware
def hsl20_4.hsl20_4.framework.get_instance_by_id | ( | self, | |
instance_id | |||
) |
Returns an instance of a block
Used for communication between two blocks. In the GLE, the ID can be made known to another block via direct wiring of the blocks.
The ID must be located within the module context.
instance_id | int Runtime ID of the building block |
def hsl20_4.hsl20_4.framework.get_instance_from_modules_by_id | ( | self, | |
module_context, | |||
instance_id | |||
) |
Returns a block instance
module_context | string Key of the module context |
instance_id | int Runtime ID of the building block |
def hsl20_4.hsl20_4.framework.get_project_id | ( | self | ) |
Returns the ID of the currently loaded project
def hsl20_4.hsl20_4.Framework.resolve_dns | ( | self, | |
host | |||
) |
Returns an IP address
Uses the DNS service of the HS/FS to resolve the host name