Show Menu
Cheatography
  1. Home >
  2. Cheat Sheets >

HassBot Commands Cheat Sheet (DRAFT) by

This is the Cheat Sheet for Home Assistant's Discord Bot - called HassBot

This is a draft cheat sheet. It is a work in progress and is not finished yet.

Share & Format

~share
Gives you inform­ation on which sites to use in order to share inform­ation or files with other Discord members.
~format
Gives you a link to an animated GIF that shows how to paste code using proper format.
~yaml?
Checks a given code is in proper YAML format.
Usage: ~yaml? ```yaml
Your YAML code
```

Basic Bot Commands

~help
Provides Help Inform­ation
~about
Provides details about the author, software version and runtime details
~ping
Responds with "­Pon­g!" if the bot is up and running. Run this command to check if the bot is running.
~pong
Responds with "­Pin­g!" - PLay ping-pong game with the bot - but do not do it in public channels. Do it in DM with the bot if you are bored!
~update
Forces the Hassbot to reload sitemap, commands and other data
~welcome
Basic welcome note, reminds you of rules.
 

Search Commands

~lookup
Looks up for a specific Keyword. It looks up in the Home Assist­ant's Sitemap file.
Usage: ~lookup sensor
~deeps­earch
Conducts deep search and provides you the results in your DM. This command may respond with large amounts of data and may take time. Use it with caution.
~list
Shows you list of commands available for you to run

Invoking HassBot

You can invoke HassBot by using
and 
.
keyboard charac­ters. Any command that starts with either
or 
.
will invoke Hassbot, and if there is a command available, it responds, otherwise it will simply ignore. To invoke help command, run the following:

~help or .help

The source code for the HassBot is available at https:­//g­ith­ub.c­om­/sk­ala­val­a/H­assBot

Fun Commands

~8ball
Predicts an answer to a given question.
Usage: ~8ball question @user
~lmgtfy
Let me google that for you!
Usage: ~lmgtfy Search­String @user
 

Docume­ntation Search

Hassbot provides a quick and easy way to search for content that is available on Home Assist­ant's Docs site. HassBot uses Sitemap data to search for content and provides you the results in the form of URLs.

For ex: To search for Binary Sensor, you can run any of the following commands:

~binar­y_s­ensor
~lookup binary sensor
~lookup sensor binary

All the commands will give you a link to https:­//w­ww.h­om­e-a­ssi­sta­nt.i­o/­com­pon­ent­s/b­ina­ry_­sensor/

AFK (Away From Keyboard)

~away
Use this command to let people know that you are away with a custom message.
Usage: ~away back in an hour
Until you return, anyone mentions your name will be provided with that message. As soon as you post a message, that away status will be taken away.

Basic Conversion Commands

~json2yaml
Converts a given JSON content to YAML
~yaml2json
Converts a given YAML text to JSON
~c2f
Converts Celsius to Fahrenheit
~f2c
Converts Fahrenheit to Celsius
~hex2dec
Converts a given Hex value to Decimal
~dec2hex
Converts a given decimal value to Hex
~bin2dec
Converts Binary value to Decimal
~dec2bin
Converts a Decimal value to BInary
~base6­4_e­ncode
Encodes a given string using Base64 encoding
~base6­4_d­ecode
Decodes a given Base64 encoded string