Utility Functions
Some useful utility functions.
Hashing functions
local md5_hash = mympd.hash_md5(string)
local sha1_hash = mympd.hash_sha1(string)
local sha256_hash = mympd.hash_sha256(string)
Parameters:
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
string | string | String to hash |
URL encoding and decoding
local encoded = mympd.urlencode(string)
local decoded = mympd.urldecode(string, form_url_decode)
Parameters:
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
string | string | String to encode/decode |
form_url_decode | boolean | Decode as form url |
Logging
Logs messages to the myMPD log.
mympd.log(loglevel, message)
Parameters:
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
message | string | Message to log |
loglevel | number | Syslog log level |
LOGLEVEL | DESCRIPTION |
---|---|
0 | Emergency |
1 | Alert |
2 | Critical |
3 | Error |
4 | Warning |
5 | Notice |
6 | Info |
7 | Debug |
Notifications
-- Send a notification to the client that has started the script
mympd.notify_client(severity, message)
-- Send a notification to all clients in the partition from which the client started the script
mympd.notify_partition(severity, message)
Parameters:
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
severity | number | 0 = Info, 1 = Warn, 2 = Error |
message | string | Message to send. |