ccil-kbw / robot Goto Github PK

• Add the Recording feature to the rec-start command in Discord Client
• Add the Stop Recording feature in OBS Client and the rec-stop command to the Discord Client

Prerequisites:

• Create Discord Bot
• Add Discord Bot to the QA Discord of KBW

Before going Public with the Bot we need to:

• Handle Multi-Tenancy for the /iqama command
• Move the Private commands to only work on the Admins Guild (/rec-*, /admin-do-)

We should put a convention in the pr.yml which will check what's up (e.g. that the title is in the format ISSUE-[0-9]: .).

This task will require some grooming.

https://ccil-kbw.github.io/droid/intro/

We're in the beginning of the MDroid2 App development. The few features we already developed but do not have a Database:

• Iqama Notification on Discord
• Automated Recordings for Lessons
• Discord Commands for Starting/Stopping/Monitoring Recordings
• Youtube Uploader

Those were developed in Golang, but for adoptability and ease of Maintainability I believe we should rewrite them in Python (Using Django)

A Design Documentation and a proper File Structure will be required to close this Ticket.

Explanation can be found here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

At the same time why not named it Masjid's Robot (or MasjidsRobot as slug)

Refactoring points:

• 1 entrypoint with a bunch of features
• Make it API based (+ generate a cli tool for flexibility while we work on some UI)

go run ./cmd/monolith/main.go throws the following error:

Cannot open the session: websocket: close 4004: Authentication failed.
exit status 1

Create a Module that will take care of Environments and Loggers Initialization to be reused in all commands.

Should be situated in folder internal/ for now

Iqama is cached when we run the Software. Needs to update every few hours the new Iqama time (Maybe every hour)

Request as curl of the ptz camera:

curl 'http://192.168.1.253/cgi-bin/ptzctrl.cgi?ptzcmd&poscall&11' \
  -H 'Content-Type: application/x-www-form-urlencoded;charset=utf-8' \
  -H 'Cookie: CGISESSION=zeFdsRYOsksdEcWymqvAmVMJeQQqURuj' \
  --compressed \
  --insecure

Here we want to detect the Frame and set it properly based on the Event:

11: Chair under Imam for Khutbah Translations
12: Zoomed Out Imam + Iqama
13: Imam Khutbah
14: Zoomed Out everything

E.g: Khutbah Translation Time: 11, Khutbah Time: 13

You can base yoursef on this: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Create different Iqama Sources with a simple configuration from the User.

At the moment we use the API from https://iqama.ccil-kbw.com but other solutions can greatly simplify Administrative Tasks.

At the moment I am thinking about a Public Google Sheets that can simply be modified manually by the Administration, the Sheet would contain a page for each year (2023, 2024, 2025, etc) and reading the Iqama would simply use the URL for the Google Sheets.

When the Administration thinks that they need to change the Iqama they simply login to their Google account and modify the Sheet directly from there. All Iqama Apps can use that Sheet as Source of Truth and is not controlled by any Developer but solely by the Masjid's Administration.

Feature: Upload newly recorded videos (private visibility, backlog playlist)

We need to sign the binary shipped for MacOS else it's flagged as insecure on those devices

https://www.mkdocs.org/
https://squidfunk.github.io/mkdocs-material/

Same page can both include technical and user documentation, split in 2 Tabs and subsections

Can simply be deployed to docs.ccil-kbw.com or something else

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>EnvironmentVariables</key>
    <dict>
        <key></key>
        <string></string>
    </dict>
    <key>Label</key>
    <string>org.masjidsrobot.darsrec</string>
    <key>ProgramArguments</key>
    <array>
        <string>/usr/local/bin/darsrec</string>
    </array>
    <key>KeepAlive</key>
    <true/>
    <key>StandardOutPath</key>
    <string>/tmp/darsrec.out</string>
    <key>StandardErrorPath</key>
    <string>/tmp/darsrec.err</string>
</dict>
</plist>

Currently hardcoded the above in ~/Library/LaunchAgents/org.masjidsrobot.darsrec.plist

Should find a better way with an install.sh script to do this automatically

This ticket includes signing the binary with Apple's Developpers - not sure about the process for non-mac users, got to investigate inchaAllah

https://github.com/uber-go/zap

Simply replace logging done by fmt and the default logging to use zap logger instead. Advantage is that they are logged as JSON and are easy to parse when ingested.