request to add Adafruit NeoKey 1x4 input board

[Nithalik]

Hi Kyle,

Found a device from adafruit that would be able to add a lot of possible functionality for people not super skilled in programming if you can add this input device. It is basically a i2c controlled mini keyboard that has 4 keyboard keys and 4 neopixels. basically a easy way to add 4 i2c controlled momentary switches to a system. It also has 8 possible i2c addresses so there is a lot of possibility here

https://www.adafruit.com/product/4980

adafruit neokey library: https://docs.circuitpython.org/projects/neokey/en/latest/

i have ordered one and been playing with it, have gotten their test code working, but getting it to work with mycodo is not working for me, with you already having neopixels added not sure if this would be complicated to sort out

[kizniche]

How were you envisioning it integrating?

[Nithalik]

im wanting to use the switches to start functions, and change what is displayed on a different i2c screen. neopixels are just a added bonus, they could be used as status led's or to show that the button was pressed and recognized

you can also have 8 of these together, so 32 total keys from one i2c bus

like be able to have a button to trigger some of the input actions on this page https://kizniche.github.io/Mycodo/Inputs/#input-actions

the more useful ones would be to trigger the supported actions which is where i would use it the most

https://kizniche.github.io/Mycodo/Supported-Actions/

button to capture a pic from all the cameras / execute command: shell / display backlight / pause would be the big ones i can think of right away.

im not currently able to access my mycodo system so not able to really go through all the different sections to see where it is useful, but i envision using it so i dont have to go into the webui when i do maintenance, i can do it by buttons.

-pause/enable everything
-run waterchange function
-pH balance / add nutrients
-turn off main lights (or dim)

[kizniche]

I could throw together a simple function that you could execute one or more actions when a button is pressed.

[Nithalik]

that would work for almost all of my use cases, and i think i can add a lot with that. the only other thing is if there would be a way to address the neoled's too.

also need to be able to change the i2c address, will probably end up using more then 1

example for 1 button - when button is pressed, runs action, then flashes the neoled while that is active. and push the button again to undo if its not one based on a timer.

[kizniche]

All three sound doable. I'll let you know when I have a module for you to test.

[Nithalik]

All three sound doable. I'll let you know when I have a module for you to test.

cool, thanks

[kizniche]

Attached below is a module to test. Rename from txt to py and import as a Function. You will also need to upgrade to master to be able to use Actions for Custom Functions and see the Action ID needed to use the new Function. The instructions after creating the Function should be sufficient to use it. I won't detail how to use it to see if the instructions can stand on their own. Let me know if you run into any issues or can't get it working. Remember to enable the Function debug logging when testing to see all debug messages in the log.

function_adafruit_neokey_01.txt

[Nithalik]

Thank you for that, got it installed.

when i push a button it just lights up the LED underneath but nothing else. below is the error log.

just have all buttons mapped to deactivate a function for testing.

your assistance here is greatly appreciated

``` AttributeError: 'list' object has no attribute 'unique_id'
2023-12-10 15:31:46,916 - ERROR - mycodo.function.function_adafruit_neokey_01_8df033ec - Executing Action with ID dd3d8ad0
Traceback (most recent call last):
  File "/home/nithalik/Mycodo/mycodo/functions/custom_functions/function_adafruit_neokey_01.py", line 236, in check_key_press
    action.unique_id,
AttributeError: 'list' object has no attribute 'unique_id'
2023-12-10 15:31:46,928 - INFO - mycodo.function.function_adafruit_neokey_01_8df033ec - Button 4
2023-12-10 15:31:47,461 - ERROR - mycodo.function.function_adafruit_neokey_01_8df033ec - Executing Action with ID 8ceb33e8
Traceback (most recent call last):
  File "/home/nithalik/Mycodo/mycodo/functions/custom_functions/function_adafruit_neokey_01.py", line 236, in check_key_press
    action.unique_id,
AttributeError: 'list' object has no attribute 'unique_id'
2023-12-10 15:31:47,473 - ERROR - mycodo.function.function_adafruit_neokey_01_8df033ec - Executing Action with ID d05c3d60
Traceback (most recent call last):
  File "/home/nithalik/Mycodo/mycodo/functions/custom_functions/function_adafruit_neokey_01.py", line 236, in check_key_press
    action.unique_id,
AttributeError: 'list' object has no attribute 'unique_id'
2023-12-10 15:31:47,486 - ERROR - mycodo.function.function_adafruit_neokey_01_8df033ec - Executing Action with ID dd3d8ad0
Traceback (most recent call last):
  File "/home/nithalik/Mycodo/mycodo/functions/custom_functions/function_adafruit_neokey_01.py", line 236, in check_key_press
    action.unique_id,
AttributeError: 'list' object has no attribute 'unique_id'

[kizniche]

Here is an updated module. Delete all of this Function type, then delete the Function module, then import this new Function module.

function_adafruit_neokey_01.txt

[kizniche]

Wait, you didn't add the correct Function. That's one of the built-in functions. Your screenshot is of the Execute Actions Function, not the Device: Adafruit Neokey (Button Executes Actions) Function.

[Nithalik]

the screenshot was just the execute actions, to show the id's

in changing the settings in it, now the method page wont load giving 500 error. i must have done something stupid. reinstalling mycodo and will test out the new file

Error (Full Traceback):

Traceback (most recent call last):
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask/app.py", line 2190, in wsgi_app
response = self.full_dispatch_request()
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask/app.py", line 1486, in full_dispatch_request
rv = self.handle_user_exception(e)
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask_restx/api.py", line 674, in error_router
return original_handler(e)
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask/app.py", line 1484, in full_dispatch_request
rv = self.dispatch_request()
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask/app.py", line 1469, in dispatch_request
return self.ensure_sync(self.view_functions[rule.endpoint])(**view_args)
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask_login/utils.py", line 290, in decorated_view
return current_app.ensure_sync(func)(*args, **kwargs)
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/routes_function.py", line 514, in page_function
return render_template('pages/function.html',
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask/templating.py", line 151, in render_template
return _render(app, template, context)
File "/var/mycodo-root/env/lib/python3.9/site-packages/flask/templating.py", line 132, in _render
rv = template.render(context)
File "/var/mycodo-root/env/lib/python3.9/site-packages/jinja2/environment.py", line 1301, in render
self.environment.handle_exception()
File "/var/mycodo-root/env/lib/python3.9/site-packages/jinja2/environment.py", line 936, in handle_exception
raise rewrite_traceback_stack(source=source)
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/templates/pages/function.html", line 3, in top-level template code
{% set help_page = ["https://kizniche.github.io/Mycodo/Functions/", dict_translation['function']['title']] %}
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/templates/layout.html", line 383, in top-level template code
{%- block body %}{% endblock -%}
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/templates/pages/function.html", line 135, in block 'body'
{% include 'pages/function_options/custom_function_entry.html' %}
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/templates/pages/function_options/custom_function_entry.html", line 51, in top-level template code
{% include 'pages/function_options/custom_function_options.html' %}
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/templates/pages/function_options/custom_function_options.html", line 292, in top-level template code
{% include 'pages/actions.html' %}
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/templates/pages/actions.html", line 40, in top-level template code
{% include 'pages/form_options/Custom_Options.html' %}
File "/home/nithalik/Mycodo/mycodo/mycodo_flask/templates/pages/form_options/Custom_Options.html", line 285, in top-level template code
<option value="{{each_dev.unique_id}}"{% if (channel_options and each_dev.unique_id == custom_options_values[unique_id][channel][each_option['id']]) or (custom_options_values and each_dev.unique_id == custom_options_values[unique_id][each_option['id']]) %} selected{% endif %}>[{{name}} {{'%02d' % each_dev.id}}] {{each_dev.name}}
File "/var/mycodo-root/env/lib/python3.9/site-packages/jinja2/environment.py", line 466, in getitem
return obj[argument]
jinja2.exceptions.UndefinedError: dict object has no element Undefined

[kizniche]

The IDs should show on all Functions. You should be only using the Function I created.

[kizniche]

What did you do in the time between it working and not working?

[Nithalik]

all i did was change the ID's in the new module to random numbers, thinking that using the id's from the execute actions function was causing the issue

[Nithalik]

i was just showing with that screenshot that i didnt make a error copying the action id's into the boxes in the new module