An ioBroker adapter for Bring! shopping lists
MIT License
===========================
The developers of this module are in no way endorsed by or affiliated with Bring! Labs AG, or any associated subsidiaries, logos or trademarks.
For a description of the created states, see below.
info.connection
Data type | Permission |
---|---|
boolean | R |
Read-only boolean indicator. If your broker is logged in on bring, the state is true otherwise false.
info.user
Data type | Permission |
---|---|
string | R |
Read only string. Contains the name of the logged-in user.
For every shopping list a channel with the following states will be created:
list.content / list.contentHtml/NoHead
Data type | Permission |
---|---|
string | R |
Read only json/html string formatted as a list or html table. Contains the items which are currently on your shopping list. The NoHead Html tables are w/o table headers. The content is translated via the dictionary to allow usage in visualization adapters.
list.recentContent / list.recentContentHtml/NoHead
Data type | Permission |
---|---|
string | R |
Read only json/html string formatted as a list or html table. Contains the items which were recently on your shopping list. The NoHead Html tables are w/o table headers. The content is translated via the dictionary to allow usage in visualization adapters.
list.removeItem/Translated
Data type | Permission |
---|---|
string | R/W |
Select an item which should be removed from the shopping list and recent content list. The state will be acknowledged when the command is acknowledged by the Bring! API. Note, that the translated states are using the dictionary before interacting with the API.
list.moveToRecentContent/Translated
Data type | Permission |
---|---|
string | R/W |
Select an item which should be moved or added to recent content list. The state will be acknowledged when the command is acknowledged by the Bring! API. Note, that the translated states are using the dictionary before interacting with the API.
list.saveItem/Translated
Data type | Permission |
---|---|
string | R/W |
Select an item which should be added to the shopping list. You can also specify additional information of the item, by setting the state by the following schema:
Apple, 2.50 $, the green ones
Note, that everything behind the comma describes the specification. The state will be acknowledged when the command is acknowledged by the Bring! API. Note, that the translated states are using the dictionary before interacting with the API.
list.users / list.usersHtml/NoHead
Data type | Permission |
---|---|
string | R |
Read only json/html string formatted as a list or html table. Contains the users which are part of the shopping list, as well as their email address. The NoHead Html tables are w/o table headers.
list.count
Data type | Permission |
---|---|
number | R |
Read only number, which represents the number of contained items of the list.
list.messageTrigger
Data type | Permission |
---|---|
button | R/W |
If you press this button, the shopping list will be sent to the configured instances, e. g. Pushover, Telegram or/and E-Mail.
list.enumSentence
Data type | Permission |
---|---|
string | R |
Read only string, which contains an enumeration of the shopping list items in a speakable form. This can be used e. g. for voice output via smart assistants.
list.translation
Data type | Permission |
---|---|
string | R |
Read only json string, which contains a dictionary to translate the swiss item names to the list language.
undefined
state when no name specifiedsetState
calls (closes #211)translated
objectssave/remove/movetoRecentContent
which translates the article before passing it to the API (closes #149)margin-top
calculation of item namecount
state beeing an empty stringpollAllLists
functionThe MIT License (MIT)
Copyright (c) 2019-2022 Moritz Heusinger [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.