A homescreen widget for iOS/iPadOS using Scriptable to display a daily schedule for Compass School Manager.
The Compass mobile app is "okay", but not particularly convenient (the student-facing interface appears to be somewhat neglected). The app also doesn't allow for any kind of colour customisation and doesn't work online. Yes, there's an iCAL export, but it isn't updated if the room or teacher changes. This widget is designed to solve this problem - allowing you quickly view your schedule and any changes to it.
- Completely customisable - change class colours, titles, and hide unwanted activity types.
- Works offline - schedule data is cached, so you can still view your schedule without internet.
- Fast - updates in less than a second as it only needs to make one HTTP request.
- Shows class changes - if your teacher or room has been changed, the widget updates to reflect this.
- Doubles are grouped together - adjacent classes within a customisable threshold can be merged together.
- Download Scriptable from the App Store.
- Create a new script, and copy the code in
scriptableInstaller.jsinto it. Run the script.
- Log in to your Compass account as normal in a private browsing window in Chrome or Firefox. This should be done on your PC or Mac. You'll need to use a private window so you don't accidentally log out of the session.
- Open the developer tools (F12 usually works)
-
- Chrome:
- Switch to the "Application" tab in the Developer Tools.
- Go to "Cookies" in the sidebar, then select your Compass domain.
- Copy the "Value" text in the row that begins with "ASP"
- Firefox:
- Switch to the "Storage" tab in the Developer Tools.
- Go to "Cookies" in the sidebar, and select your Compass domain.
- Copy the "Value" text in the row that begins with "ASP"
- Chrome:
- Open
CompassWidgetin the Scriptable editor and changesessionToken: ""to session token you copied in Step 3. - Now close the private window, making sure that you do not log out of Compass.
You should now be able to run the script and view the widget preview.
To add the widget to your homescreen, switch to the "Scriptable" section in the widget chooser and choose either the "large" or "extra large" sizes (smaller sizes aren't currently supported). Choose the "CompassWidget" script, and change "When Interacting" to "Run Script".
The widget will update periodically depending on device usage - this behaviour is controlled by iOS and can't be customised.
Modify the widgetConfig object to customise and configure the widget.
| Key | Type | Description |
|---|---|---|
sessionToken |
string |
The session token for a valid Compass session. |
userId |
int |
The userId of the schedule to view. If you're a student, you'll only be able to view your own. |
showCancelledEvents |
bool |
Whether to show activities that have been cancelled. |
showElapsedEvents |
bool |
Whether to show activities that have concluded. Stale events may remain on the widget for a period of time if iOS does not updated the widget. |
showEventTypes |
[Compass.enums.ActivityType] |
Types of activites to show. Valid values are in Compass.enums.ActivityType |
doubleThresholdMinutes |
int |
The maxiumum amount of time (in minutes) between two activities with the same name before they are counted as a double. |
customisations |
object |
Activity-specific colour and titles customisations. |
customisations.templates |
object |
Named templates for colour and title customisation. |
customisations.templates.{id} |
object |
Named templates for colour and title customisation. |
customisations.templates.{id}.backgroundColor |
string?, hex colour |
Background colour for that template. |
customisations.templates.{id}.color |
string?, hex colour |
Text colour for that template. |
customisations.templates.{id}.accentColor |
string?, hex colour |
Room text colour for that template. |
customisations.templates.{id}.name |
string? |
This will override the class name with the specified (mostly useful for students, who typically don't need to to identify between different faculties). |
customisations.mappings |
object |
Mappings that link class names to templates. In the format of className: templateId |
debugUseDate |
string? |
Fetch the schedule for the given date in the form YYYY-MM-DD; mainly used for development. If omitted the current date will be used. |
PRs are welcome! Please describe and justify your changes.
This code is licensed under the Mozilla Public License 2.0. This means you can use and modify it as you see fit (including commercial use), providing that you attribute this repository.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent