SlackRtm

KO | EN

gitlite — search

#llm #go #golang #machine-learning #deep-learning #macos #nodejs #java #cli #security #openai #ios #mcp #open-source

(★ 11)

primitive library for c++ to access the slack real time messaging api

SlackRtm Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**Don't use this - it's horribly out of date and slack API changes mean it's largely non-functional**

SlackRtm
========

SlackRtm is a very minimal c++ library for the Slack Real Time Messaging protocol, with an example app (slackmqtt) that acts as a bridge between slack and an MQTT broker such as Mosquitto - this makes it particularly easy for Arduinos making use of the [pubsubclient library](https://github.com/knolleary/pubsubclient) to message a slack channel.

* http://slack.com/
* http://mosquitto.org/

## Features

* At present, only allows for messages to be sent to/from slack channels - i.e. no support for private messages, private channels, etc.

## Requirements

* Linux; current only tested on Debian Stretch.
* Required packages: g++ libjson-c-dev libcurl4-gnutls-dev libutfcpp-dev libboost-dev libmosquittopp-dev libmosquitto-dev mosquitto mosquitto-clients libwebsockets-dev cmake

## slackmqtt
### Building

1. Install the required packages: "apt-get install g++ libjson-c-dev libcurl4-gnutls-dev libutfcpp-dev libboost-dev libmosquittopp-dev libmosquitto-dev mosquitto mosquitto-clients libwebsockets-dev cmake"
2. After cloning, run "cmake ." in the root

### Usage

1. Get an API token from Slack, goto:
  Configure Intergrations
  DIY Integrations & Customizations -> Bots
  Pick a username -> add Intergration
  Note down the "API Token"
  
2. Run SlackMqtt, and specifiy (at minimum) the API key:

```
./examples/mqtt/SlackMqtt -k "<token>"
```

By default, SlackMqtt expects to find an MQTT broker running on localhost, port 1883; this can be overridden by passing the "-p \<port\>" and/or "-h \<host\>" parameters.

Once running, messages in any of the Slack channels the bot is present in will be published to the MQTT topic "slack/rx/\<channel\>"; this can be seen by running something like "mosquitto_sub -t 'slack/rx/#'" in another terminal. The MQTT topic used can be changed by the "-r \<topic\>" parameter.

Messages published to the MQTT topic "slack/tx/\<channel\>" will be sent to the Slack channel \<channel\>, provided that the bot is already present in that channel (i.e. has been invited in). This MQTT topic can be changed by the "-t \<topic\>" parameter.
E.g. to send a message to #general, run "mosquitto_pub -t 'slack/tx/general' -m 'hello, world'".

### Glaring ommisions
* No ability to send PMs
* No systemd, upstart or init script included yet, so needs be ran directly from the console. It is able to redirect logging to syslog (parameter "-l SYSLOG"), so writing such a script probably isn't hard
* Only tested on - and for the moment, probably only works on - Debian Stretch
* Probably a lot more

## slackrtm
TODO: Some/more documentation on the slackrtm library.

SlackRtm

SlackRtm Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

SlackRtm

SlackRtm Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README