Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-2400: Add snippets for resource base methods #231

Merged
merged 1 commit into from
Jun 14, 2024
Merged

DOCS-2400: Add snippets for resource base methods #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions lib/src/resource/base.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,22 @@ class Subtype {
const Subtype(this.namespace, this.resourceType, this.resourceSubtype);

/// Create a new [Subtype] from a [ResourceName]
///
/// ```
/// // Example, creating a Sensor from a resource named "mySensor":
/// var mySensor = Sensor.fromResourceName('mySensor');
/// ```
Comment on lines +29 to +33
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
///
/// ```
/// // Example, creating a Sensor from a resource named "mySensor":
/// var mySensor = Sensor.fromResourceName('mySensor');
/// ```

Should these actually not be here since they're not part of the API?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There may be considerations I'm not thinking of but it seems harmless and more thorough to include these.

Subtype.fromResourceName(ResourceName name)
: namespace = name.namespace,
resourceType = name.type,
resourceSubtype = name.subtype;

/// Get a [ResourceName] from this [Subtype] and a provided [name]
///
/// ```
/// // Example, getting the ResourceName of a sensor named "my_sensor":
/// var resourceName = Sensor.getResourceName('my_sensor');
/// ```
Comment on lines +40 to +44
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
///
/// ```
/// // Example, getting the ResourceName of a sensor named "my_sensor":
/// var resourceName = Sensor.getResourceName('my_sensor');
/// ```

ResourceName getResourceName(String name) {
return ResourceName()
..namespace = namespace
Expand All @@ -56,6 +66,12 @@ abstract class Resource {
abstract final String name;

/// Send/Receive arbitrary commands to the [Resource]
///
/// ```
/// // Example using doCommand with an arm component
/// const command = {'cmd': 'test', 'data1': 500};
/// var result = myArm.doCommand(command);
/// ```
Future<Map<String, dynamic>> doCommand(Map<String, dynamic> command) {
throw UnimplementedError();
}
Expand Down