Skip to content

Commit

Permalink
Merge pull request #190 from FlowFuse/rebranding
Browse files Browse the repository at this point in the history
Update a bunch of branding issues
  • Loading branch information
hardillb authored Oct 26, 2023
2 parents bcb8f6f + 465b8bc commit b57119a
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 39 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# FlowForge Device Agent
# FlowFuse Device Agent

This module provides an agent that runs Node-RED instances deployed from the
FlowForge platform.
FlowFuse platform.

## Prerequisites

- NodeJS v14 or later
- A FlowForge platform to connect to
- A FlowFuse platform to connect to

## Supported Operating Systems

Expand Down Expand Up @@ -68,7 +68,7 @@ mkdir c:\opt\flowforge-device

### `device.yml` - for a single device

When the device is registered on the FlowForge platform, a group of configuration
When the device is registered on the FlowFuse platform, a group of configuration
details are provided. These can be copied from the platform, or downloaded directly
as a yml file.

Expand All @@ -77,14 +77,14 @@ This file should be copied into the working directory as `device.yml`.
A different config file can be specified with the `-c/--config` option.

The file must contain the following options (these are the ones provided by
FlowForge)
FlowFuse)

Required options | Description
-------------------|---------------
`deviceId` | The id for the device on the FlowForge platform
`deviceId` | The id for the device on the FlowFuse platform
`token` | Access Token to connect to the FF platform
`credentialSecret` | Key to decrypt the flow credentials
`forgeURL` | The base url of the FlowForge platform
`forgeURL` | The base url of the FlowFuse platform

To enable MQTT connectivity, the following options are required. They are provided
by the platform if MQTT comms are enabled.
Expand Down Expand Up @@ -155,8 +155,8 @@ httpStatic:

### `device.yml` - for provisioning

When a device should be auto registered on the FlowForge platform, a group of provisioning
configuration details are required. These are generated for you in FlowForge
When a device should be auto registered on the FlowFuse platform, a group of provisioning
configuration details are required. These are generated for you in FlowFuse
**Team Settings** under the **Devices** tab when you create a provisioning token.
These can be copied from the platform, or downloaded directly as a yml file.

Expand All @@ -165,14 +165,14 @@ This file should be copied into the working directory as `device.yml`.
A different config file can be specified with the `-c/--config` option.

The file must contain the following options (these are the ones provided by
FlowForge)
FlowFuse)

Required options | Description
--------------------|---------------
`provisioningName` | The name of the token
`provisioningTeam` | The team this device will be registered to
`provisioningToken` | Provisioning Token to connect to the FF platform
`forgeURL` | The base url of the FlowForge platform
`forgeURL` | The base url of the FlowFuse platform

The following options can be added:

Expand Down Expand Up @@ -248,7 +248,7 @@ OS and Architecture as your target device, and then copy the modules on to your

## Running as a service

An example service file is provided [here](https://github.com/flowforge/flowforge-device-agent/tree/main/service).
An example service file is provided [here](https://github.com/FlowFuse/device-agent/tree/main/service).

## Running the agent with the Web UI enabled

Expand Down
4 changes: 2 additions & 2 deletions frontend/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<head>
<meta charset="UTF-8">
<title>Device Agent - FlowForge</title>
<title>Device Agent - FlowFuse</title>
<link rel="icon" href="assets/favicon.ico">
<link rel="icon" type="image/png" sizes="32x32" href="assets/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="assets/favicon-16x16.png">
Expand Down Expand Up @@ -321,7 +321,7 @@

</div>
<div class="hero-header-item hero-header-item-2">Device Agent</div>
<div class="hero-header-item hero-header-item-3"><a class="flex items-center gap-2" href="https://flowforge.com/docs/user/devices/#devices" target="_blank">docs</a></div>
<div class="hero-header-item hero-header-item-3"><a class="flex items-center gap-2" href="https://flowfuse.com/docs/device-agent/introduction/" target="_blank">docs</a></div>
</header>

<main>
Expand Down
4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env node
const semver = require('semver')
if (semver.lt(process.version, '14.0.0')) {
console.log('FlowForge Device Agent requires at least NodeJS v14.x')
console.log('FlowFuse Device Agent requires at least NodeJS v14.x')
process.exit(1)
}

Expand Down Expand Up @@ -78,7 +78,7 @@ function main (testOptions) {
delete options.config
AgentManager.init(options)

info('FlowForge Device Agent')
info('FlowFuse Device Agent')
info('----------------------')

if (options.ui) {
Expand Down
4 changes: 2 additions & 2 deletions lib/AgentManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ class AgentManager {
// Provision this device in the forge platform and receive the device ID, credentials and other details
postResponse = await got.post(`${provisioningConfig.forgeURL}/api/v1/devices`, {
headers: {
'user-agent': `FlowForge Device Agent v${this.configuration?.version || ' unknown'}`,
'user-agent': `FlowFuse Device Agent v${this.configuration?.version || ' unknown'}`,
authorization: `Bearer ${provisioningConfig.token}`
},
timeout: {
Expand Down Expand Up @@ -292,7 +292,7 @@ class AgentManager {
try {
forgeCheck = await got.get(forgeURL, {
headers: {
'user-agent': `FlowForge Device Agent v${this.configuration.version}`,
'user-agent': `FlowFuse Device Agent v${this.configuration.version}`,
authorization: `Bearer ${this.configuration.token}`
},
timeout: {
Expand Down
6 changes: 3 additions & 3 deletions lib/cli/usage.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ module.exports = {
usage: () => {
return commandLineUsage([
{
header: 'FlowForge Device Agent',
content: `Run FlowForge instances on a device.\n\n Version: ${version}`
header: 'FlowFuse Device Agent',
content: `Run FlowFuse instances on a device.\n\n Version: ${version}`
},
{
header: 'Options',
Expand All @@ -26,7 +26,7 @@ module.exports = {
},
{
header: 'Project Home',
content: '{underline https://github.com/flowforge/flowforge-device-agent}'
content: '{underline https://github.com/FlowFuse/device-agent}'
}
])
}
Expand Down
6 changes: 3 additions & 3 deletions lib/http.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const { IntervalJitter } = require('./IntervalJitter')

class HTTPClient {
/**
* HTTP Client for the FlowForge API
* HTTP Client for the FlowFuse API
* @param {import('./agent').Agent} agent
* @param {Object} config
*/
Expand All @@ -20,7 +20,7 @@ class HTTPClient {
this.client = got.extend({
prefixUrl: `${this.config.forgeURL}/api/v1/devices/${this.config.deviceId}/`,
headers: {
'user-agent': `FlowForge Device Agent v${this.config.version}`,
'user-agent': `FlowFuse Device Agent v${this.config.version}`,
authorization: `Bearer ${this.config.token}`
},
timeout: {
Expand Down Expand Up @@ -83,7 +83,7 @@ class HTTPClient {
return
}
if (!this.completedInitialCheckin) {
info('Connecting to FlowForge platform to verify device state')
info('Connecting to FlowFuse platform to verify device state')
}
// If we're not in provisioning mode, post the state to the server
debug('Calling home')
Expand Down
8 changes: 4 additions & 4 deletions lib/launcher.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ const MIN_RESTART_TIME = 10000 // 10 seconds
const MAX_RESTART_COUNT = 5

const packageJSONTemplate = {
name: 'flowforge-project',
description: 'A FlowForge Project',
name: 'flowfuse-project',
description: 'A FlowFuse Project',
private: true,
version: '0.0.1',
dependencies: {
Expand Down Expand Up @@ -193,8 +193,8 @@ class Launcher {
path.join(__dirname, 'plugins', 'node_modules', '@flowforge', 'flowforge-library-plugin')
]
const sharedLibraryConfig = {
id: 'flowforge-team-library',
type: 'flowforge-team-library',
id: 'flowfuse-team-library',
type: 'flowfuse-team-library',
label: 'Team Library',
icon: 'font-awesome/fa-users',
baseURL: this.config.forgeURL + '/storage', // Ideally, this would come from the model via API however it is currently just a virtual column of forgeURL + '/storage'
Expand Down
2 changes: 1 addition & 1 deletion lib/mqtt.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const EditorTunnel = require('./editor/tunnel')

class MQTTClient {
/**
* MQTT Client for the FlowForge API
* MQTT Client for the FlowFuse API
* @param {import('./agent').Agent} agent
* @param {Object} config
*/
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/template/template-settings.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const auth = {
timeout: { request: 2000 },
headers: {
'x-access-token': token,
'user-agent': 'FlowForge Device Agent Node-RED admin auth'
'user-agent': 'FlowFuse Device Agent Node-RED admin auth'
}
})
const { username, permissions } = JSON.parse(result.body)
Expand Down

0 comments on commit b57119a

Please sign in to comment.