feat!: rename to Companion Satellite and move to bitfocus org

bitfocus · Jul 3, 2021 · 31b723a · 31b723a
1 parent 71a5165
commit 31b723a
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,43 +2,43 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [0.2.2](https://github.com/julusian/companion-remote/compare/v0.2.1...v0.2.2) (2021-02-01)
+### [0.2.2](https://github.com/bitfocus/companion-satellite/compare/v0.2.1...v0.2.2) (2021-02-01)
 
 
 ### Bug Fixes
 
-* allow a few unacked pings before restarting connection ([7c880a2](https://github.com/julusian/companion-remote/commit/7c880a288c08245e42b2844068e233e8e5d3a4d6))
-* handle reconnect better ([be5ad79](https://github.com/julusian/companion-remote/commit/be5ad798a57a1f58e4f8462fc7faddeec90151f7))
-* headless process not exiting ([3821983](https://github.com/julusian/companion-remote/commit/3821983765fdb9292c6cdcd4ea84bd93debc40e5))
-* on device detect scan now and after a short delay. often on mac the delay is needed to find the device when scanning ([375d5d4](https://github.com/julusian/companion-remote/commit/375d5d4038b56c998004ee20cb540a3e7c746c4f))
-* opening connection to localhost before target at starutp ([118d149](https://github.com/julusian/companion-remote/commit/118d149f2e29330d350dabffdfd8b6794ec56125))
-* replace packet parsing recursion with a loop to avoid max call stack issues ([bb46f5a](https://github.com/julusian/companion-remote/commit/bb46f5a211cc7e76f1479b98f85e7b07e708a297))
+* allow a few unacked pings before restarting connection ([7c880a2](https://github.com/bitfocus/companion-satellite/commit/7c880a288c08245e42b2844068e233e8e5d3a4d6))
+* handle reconnect better ([be5ad79](https://github.com/bitfocus/companion-satellite/commit/be5ad798a57a1f58e4f8462fc7faddeec90151f7))
+* headless process not exiting ([3821983](https://github.com/bitfocus/companion-satellite/commit/3821983765fdb9292c6cdcd4ea84bd93debc40e5))
+* on device detect scan now and after a short delay. often on mac the delay is needed to find the device when scanning ([375d5d4](https://github.com/bitfocus/companion-satellite/commit/375d5d4038b56c998004ee20cb540a3e7c746c4f))
+* opening connection to localhost before target at starutp ([118d149](https://github.com/bitfocus/companion-satellite/commit/118d149f2e29330d350dabffdfd8b6794ec56125))
+* replace packet parsing recursion with a loop to avoid max call stack issues ([bb46f5a](https://github.com/bitfocus/companion-satellite/commit/bb46f5a211cc7e76f1479b98f85e7b07e708a297))
 
-### [0.2.1](https://github.com/julusian/companion-remote/compare/v0.2.0...v0.2.1) (2021-01-21)
+### [0.2.1](https://github.com/bitfocus/companion-satellite/compare/v0.2.0...v0.2.1) (2021-01-21)
 
 
 ### Bug Fixes
 
-* replace canvas with sharp for  card generation. ensure queue is discarded when device is registered and ready for images ([7639666](https://github.com/julusian/companion-remote/commit/76396664101ac80462f4884f999ccd3d97c41707))
+* replace canvas with sharp for  card generation. ensure queue is discarded when device is registered and ready for images ([7639666](https://github.com/bitfocus/companion-satellite/commit/76396664101ac80462f4884f999ccd3d97c41707))
 
-## [0.2.0](https://github.com/julusian/companion-remote/compare/v0.1.0...v0.2.0) (2021-01-20)
+## [0.2.0](https://github.com/bitfocus/companion-satellite/compare/v0.1.0...v0.2.0) (2021-01-20)
 
 
 ### Features
 
-* add scan option to tray menu ([cbbd6dd](https://github.com/julusian/companion-remote/commit/cbbd6dd36f60dc1cf76e67bb7eb7d666d86106cf))
-* basic status card on streamdecks ([2ae218c](https://github.com/julusian/companion-remote/commit/2ae218cf4244084df695cfa10490434d26ec2929))
-* electron 10 ([95d126e](https://github.com/julusian/companion-remote/commit/95d126ed83bc8033f5c94474d9a1dead1978c6ad))
-* naive ping tracking, to quickly detect timeouts ([98c11f9](https://github.com/julusian/companion-remote/commit/98c11f98b078a6e63d0fa6856f13b526117fa91c))
+* add scan option to tray menu ([cbbd6dd](https://github.com/bitfocus/companion-satellite/commit/cbbd6dd36f60dc1cf76e67bb7eb7d666d86106cf))
+* basic status card on streamdecks ([2ae218c](https://github.com/bitfocus/companion-satellite/commit/2ae218cf4244084df695cfa10490434d26ec2929))
+* electron 10 ([95d126e](https://github.com/bitfocus/companion-satellite/commit/95d126ed83bc8033f5c94474d9a1dead1978c6ad))
+* naive ping tracking, to quickly detect timeouts ([98c11f9](https://github.com/bitfocus/companion-satellite/commit/98c11f98b078a6e63d0fa6856f13b526117fa91c))
 
 
 ### Bug Fixes
 
-* allow changing connection while connceted ([01039b4](https://github.com/julusian/companion-remote/commit/01039b4a7f688db03b0f5fbdd1d0f16f3c470f89))
-* allow html in description ([6b78224](https://github.com/julusian/companion-remote/commit/6b7822483ee25d924cf5dc88cf7e787a251ee60b))
-* changing ip doesnt error so much ([31fb0a7](https://github.com/julusian/companion-remote/commit/31fb0a76f775eedb73a7b51283f2714f80b1fbfa))
-* electron freezing after closing dialog, or exiting after the ip prompt ([7b0bad2](https://github.com/julusian/companion-remote/commit/7b0bad243a1cf5d9b6a030e20608b586ef47c200))
-* ensure connection is cleaned up on exit ([53edebf](https://github.com/julusian/companion-remote/commit/53edebfd734ffa07c4dcca822fb5cbb5ec567629))
-* load icon image manually, as canvas can't read from asar ([f047da4](https://github.com/julusian/companion-remote/commit/f047da4a8cac3ee9d38d37a6a61217e34f02a708))
-* not quitting ([cc6e061](https://github.com/julusian/companion-remote/commit/cc6e0619284504e0446c69ced766a36a7f85186f))
-* scan for devices at startup while no companion connection. show key status on devices before they are fully initialised ([cee053f](https://github.com/julusian/companion-remote/commit/cee053f89ea2d23dc447e57d37f7fd9917daa917))
+* allow changing connection while connceted ([01039b4](https://github.com/bitfocus/companion-satellite/commit/01039b4a7f688db03b0f5fbdd1d0f16f3c470f89))
+* allow html in description ([6b78224](https://github.com/bitfocus/companion-satellite/commit/6b7822483ee25d924cf5dc88cf7e787a251ee60b))
+* changing ip doesnt error so much ([31fb0a7](https://github.com/bitfocus/companion-satellite/commit/31fb0a76f775eedb73a7b51283f2714f80b1fbfa))
+* electron freezing after closing dialog, or exiting after the ip prompt ([7b0bad2](https://github.com/bitfocus/companion-satellite/commit/7b0bad243a1cf5d9b6a030e20608b586ef47c200))
+* ensure connection is cleaned up on exit ([53edebf](https://github.com/bitfocus/companion-satellite/commit/53edebfd734ffa07c4dcca822fb5cbb5ec567629))
+* load icon image manually, as canvas can't read from asar ([f047da4](https://github.com/bitfocus/companion-satellite/commit/f047da4a8cac3ee9d38d37a6a61217e34f02a708))
+* not quitting ([cc6e061](https://github.com/bitfocus/companion-satellite/commit/cc6e0619284504e0446c69ced766a36a7f85186f))
+* scan for devices at startup while no companion connection. show key status on devices before they are fully initialised ([cee053f](https://github.com/bitfocus/companion-satellite/commit/cee053f89ea2d23dc447e57d37f7fd9917daa917))
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-## Companion Remote
+## Companion Satellite
 
-[![License](https://img.shields.io/github/license/julusian/companion-remote)](https://github.com/Julusian/companion-remote/blob/master/LICENSE.md)
-[![Version](https://img.shields.io/github/v/release/julusian/companion-remote)](https://github.com/Julusian/companion-remote/releases)
+[![License](https://img.shields.io/github/license/bitfocus/companion-satellite)](https://github.com/Julusian/companion-satellite/blob/master/LICENSE.md)
+[![Version](https://img.shields.io/github/v/release/bitfocus/companion-satellite)](https://github.com/Julusian/companion-satellite/releases)
 
 A small application to allow for connecting a streamdeck to [Bitfocus Companion](https://github.com/bitfocus/companion) over a network.
 
 Companion 2.1.2 and newer are supported
 
-Each device will appear in companion as its own 'satellite' device, and so can be configured as if they are local.
+Each device will appear in companion as its own 'satellite' device, and can be configured as if they are local.
 
 Note: This connects over the satellite device api which uses port TCP 37133.
 
@@ -40,15 +40,15 @@ An example systemd unit (make sure to update the paths and companion ip as appro
 
 ```
 [Unit]
-Description=Bitfocus Companion Remote
+Description=Bitfocus Companion Satellite
 After=network-online.target
 Wants=network-online.target
 
 [Service]
 Type=simple
 User=pi
-WorkingDirectory=/home/pi/companion-remote
-ExecStart=node /home/pi/companion-remote/dist/main.js 192.168.0.1
+WorkingDirectory=/home/pi/companion-satellite
+ExecStart=node /home/pi/companion-satellite/dist/main.js 192.168.0.1
 Restart=on-failure
 KillSignal=SIGINT
 TimeoutStopSec=60

diff --git a/package.json b/package.json
@@ -1,20 +1,20 @@
 {
-  "name": "companion-remote",
+  "name": "companion-satellite",
   "version": "0.2.2",
-  "description": "Remote Streamdeck connector for Bitfocus Companion",
+  "description": "Satellite Streamdeck connector for Bitfocus Companion",
   "author": {
     "name": "Julian Waller",
     "email": "git@julusian.co.uk",
     "url": "https://github.com/julusian"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/julusian/companion-remote.git"
+    "url": "git+https://github.com/bitfocus/companion-satellite.git"
   },
   "bugs": {
-    "url": "https://github.com/julusian/companion-remote/issues"
+    "url": "https://github.com/bitfocus/companion-satellite/issues"
   },
-  "homepage": "https://github.com/julusian/companion-remote#readme",
+  "homepage": "https://github.com/bitfocus/companion-satellite#readme",
   "main": "dist/electron.js",
   "license": "MIT",
   "private": true,
@@ -76,19 +76,24 @@
   },
   "build": {
     "productName": "Companion Remote",
-    "appId": "remote.companion.julusian.dev",
+    "appId": "remote.companion.bitfocus.no",
+    "remoteBuild": false,
     "directories": {
       "buildResources": "assets/",
       "output": "electron-output/"
     },
     "mac": {
-      "category": "dev.julusian.companion.remote",
+      "category": "no.bitfocus.companion.remote",
       "target": "dmg",
       "extendInfo": {
         "LSBackgroundOnly": 1,
         "LSUIElement": 1
       }
     },
+    "dmg": {
+      "artifactName": "companion-satellite-${arch}.dmg",
+      "sign": true
+    },
     "win": {
       "target": "nsis"
     },

diff --git a/src/electron.ts b/src/electron.ts
@@ -7,14 +7,14 @@ import openAboutWindow from 'electron-about-window'
 import { DeviceManager } from './devices'
 import { CompanionSatelliteClient } from './client'
 
-const store = new electronStore<RemoteConfig>()
+const store = new electronStore<SatelliteConfig>()
 let tray: Tray | undefined
 
 app.on('window-all-closed', () => {
 	// Block default behaviour of exit on close
 })
 
-interface RemoteConfig {
+interface SatelliteConfig {
 	remoteIp: string
 }
 
@@ -96,8 +96,8 @@ function trayQuit() {
 	console.log('quit click')
 	dialog
 		.showMessageBox({
-			title: 'Companion Remote',
-			message: 'Are you sure you want to quit Companion Remote?',
+			title: 'Companion Satellite',
+			message: 'Are you sure you want to quit Companion Satellite?',
 			buttons: ['Quit', 'Cancel'],
 		})
 		.then((v) => {
@@ -122,16 +122,16 @@ function trayAbout() {
 	console.log('about click')
 	openAboutWindow({
 		icon_path: path.join(__dirname, '../assets', 'icon.png'),
-		product_name: 'Companion Remote',
+		product_name: 'Companion Satellite',
 		use_inner_html: true,
-		description: 'Remote Streamdeck connector for Bitfocus Companion <br />Supports 2.1.2 and newer',
+		description: 'Satellite Streamdeck connector for Bitfocus Companion <br />Supports 2.1.2 and newer',
 		adjust_window_size: false,
 		win_options: {
 			resizable: false,
 		},
-		bug_report_url: 'https://github.com/julusian/companion-remote/issues',
+		bug_report_url: 'https://github.com/bitfocus/companion-satellite/issues',
 		copyright: '2021 Julian Waller',
-		homepage: 'https://github.com/julusian/companion-remote',
+		homepage: 'https://github.com/bitfocus/companion-satellite',
 		license: 'MIT',
 		use_version_info: true,
 	})

diff --git a/src/main.ts b/src/main.ts
@@ -6,10 +6,10 @@ import { DeviceManager } from './devices'
 const cli = meow(
 	`
 	Usage
-	  $ companion-remote hostname
+	  $ companion-satellite hostname
 
 	Examples
-	  $ companion-remote 192.168.1.100
+	  $ companion-satellite 192.168.1.100
 `,
 	{}
 )