home-assistant / hassbot

HassBot is the chat assistant for the Home Assistant chatrooms on Gitter.

HassBot

HassBot is the chat assistant for the Home Assistant chatrooms on Gitter.

Purpose

The goal of HassBot is to help productivity in providing support to other users of Home Assistant.

1. HassBot should have a personality and sense of humor as part of being productive. Please do not submit entertainment scripts with no practical use for productivity.
2. HassBot should not flood the chat rooms, keep responses as short as possible or respond with a private message for longer responses.
3. HassBot should not annoy, insult, or harrass users. This includes scripting that returns false positives and posting when it shouldn't.

Contribute

Feel free to contribute to the evolution of HassBot.

1. Fork the HassBot repository at https://github.com/home-assistant/hassbot.
2. Get a local copy: git clone https://github.com/[your_username]/hassbot.git
3. Add our branch for rebasing: git remote add upstream https://github.com/home-assistant/hassbot.git
4. Create a new working branch: git checkout -b [new_branch]
5. Make your changes.
6. Stage your changes: git add .
7. Commit your changes: git commit -m "[Add a brief description of changes.]"
8. Upload changes to your fork: git push origin [branch_name]
9. Compare and Submit Pull Request to the dev branch on GitHub.com.

Testing

1. Create a separate Gitter user for testing.
2. Join the new user to a chat with your main account.
3. Get your Gitter Personal Access Token for the test user at https://developer.gitter.im
4. Run $ HUBOT_GITTER2_TOKEN=[Test_user_personal_access_token] ./bin/hubot -a gitter2 --name [test-user-name]

Considerations

• hubot
• Home Assistant

hassbot's Issues

Add user status tracking

We should add status.coffee script for user status tracking. It should conform with our triggers. "/away" "/back" and add a "/seen" function.

Rules responses are too fuzzy

I used a keyword for rules but still got a fuzzy response.

@justweb1
/rule @user hastebin
@HassBot
@user * Please use hastebin when posting large chunks of code or log output.

• All feature requests and enhancements need to be submitted in the Community Forum.

Newly joined users not being detected

Hassbot is not picking up new users that join after it is launched in a room. It will not accept commands from these users. We need to do some testing by checking logs to see if the hubot core is even picking up these events and potentially write a helper script to fix the issue.

Add Rule for inappropriate language

Add Rule for inappropriate language

HassBot not picking up new Users and Rooms or PM's

• New users to a room that join after hassbot has been built cannot use hassbot.
• When hassbot joins a new room or PM after being built nobody has access to hassbot.

Is this still active?

Is this project still active? @justweb1 @dale3h

Add Multi-room support

Add multi-room support where needed to be able support different command sets based on the room.

ex. /rules @username chat returns @username This chat room is for developers only; please ask your question in the main Home-Assistant chat.

If HassBot is in the main chat, this does not need to be an option.

Anti-flood script

Add a script that can detect room flooding and do a few things.

1. Ban user from Hassbot in the chatroom
2. Advise them via PM.
3. Allow them to continue using Hassbot through PM.