Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ethymoney/microsoft-teams-presence-detector

A simple Node.js app that detects changes to your online presence (status) in Microsoft Teams for taking custom actions on changes. For example, turning on/off lights! WARNING: NOT compatible with "new" teams currently!
https://github.com/ethymoney/microsoft-teams-presence-detector

automation availability microsoft-teams nodejs online-status presence status-update-notifications teams

Last synced: 2 days ago
JSON representation

A simple Node.js app that detects changes to your online presence (status) in Microsoft Teams for taking custom actions on changes. For example, turning on/off lights! WARNING: NOT compatible with "new" teams currently!

Awesome Lists containing this project

README 

        


  Teams Logo

       

  Available Icon

       

  Away Icon

       

  Busy Icon

       




# Microsoft Teams Presence Detector



This is a Node.js application that monitors the Microsoft Teams log file for user presence state change events and provides triggers to act on changes. This allows detection of changes to your online status (e.g., when you go from Available to Away) which can be used to trigger other actions, such as turning on/off lights in your home office, sending notifications to other applications, changing a status light color at your desk, and much more! Personally, I use this at work to change the color of an RGB light on my desk to indicate my status and tell people if I'm available or not before they walk over to ask me something.



## 🛑NOTICE: This is NOT compatible with the "new" Teams🛑

This only works with the old(classic) Teams due to the new one not writing presence states to a local log file like it used to, which this program depends on. Unfortunately, [Microsoft has ended support of the classic Teams client as of July 1st 2024](https://learn.microsoft.com/en-us/microsoftteams/teams-classic-client-end-of-availability). This could change in the future where this log file method works again, but there's a good chance that Microsoft made this change to force you to use the Graph API. This project was originally created in attempt to avoid the Graph API, using local-only resources and no need for fiddling with authentication and API calls for a client literally running locally anyways... Oh well, giveth and taketh away.



Until the log file starts having presence written to it again (if ever), this project is not functional and only serves as an archived reference to the way this used to work.







## How It Works



The application watches the Teams log file for changes and uses regular expressions to extract the current state from the log entries. It keeps track of the last known size of the file and reads the new content after each change. It compares the new state with the previous state to identify the latest presence state and alert when it has changed.



The best part? No cloud connection, API, or any authentication is needed thanks to the simplicity of just reading a log file stored on your local machine. Luckily, Microsoft writes presence changes to the log file, so we can do away with all the complicated Azure account and Graph API setup and authentication.



The app will detect what operating system you're on and your username so it can dynamically update the file location path of the Teams log file before it loads it. If for some reason yours fails to load or your file is in a different place than expected (like some flavors of Linux), you can manually set the file path in the code to where your file is. Just remove the part that checks the operating system and set it yourself.



## Prerequisites



- Node.js v18 or higher

- Microsoft Teams (desktop app only, not browser version)

- Running on Windows 10/11, MacOS (Apple Silicon too!), and most flavors of Linux



## Installation



1. Clone the repository:



      `git clone https://github.com/EthyMoney/Microsoft-Teams-Presence-Detector.git`



2. Navigate to the project directory:



      `cd Microsoft-Teams-Presence-Detector`



3. Open `main.js` and add your code for what you want to have happen when your presence changes. The current example code will print the current presence state and changes to the console, customize it to your needs.



4. Run it:



      `node main.js`   Note: The step to install dependencies was left out purposefully because this doesn't require any more than just Node.js itself!



That's it! You can now use this to trigger other actions based on your presence status.



## Example Output (from the current example code in main.js that just prints to the console)



```

hello, !

Running on Windows

log file loaded, current lines count: 19631

Latest state change on startup: Available  

watching file for changes...

Latest state change detected: Busy

Latest state change detected: Available

```



## License



This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.



## Contributing



If you have any suggestions or improvements, please open an issue, or pull request. I'm always looking for ways to improve and would love to hear your feedback!