cdplogger-client
v1.1.0
Published
A JavaScript client for interacting with CDP Logger or LogServer via WebSocket
Maintainers
cdptechReadme
CDP Logger Client
A JavaScript client for reading historic data from systems created with the CDP Studio development platform. For more information about CDP Studio, see https://cdpstudio.com/. For more information about CDP Logger, see https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-index.html.
This client allows you to:
- Connect to a CDP Logger or LogServer component
- Request logged nodes and their metadata
- Retrieve data points for specific nodes
- Query events from the logger
- Get log limits and API version information
Installation
npm install cdplogger-clientQuick Start
For a quick introduction, see the QUICKSTART.md guide.
Documentation
For detailed documentation, see DOCUMENTATION.md.
Usage
Node.js
const cdplogger = require('cdplogger-client');
const client = new cdplogger.Client('127.0.0.1:17000');
// List logged nodes
client.requestLoggedNodes().then(nodes => {
console.log("Available nodes:", nodes);
});Browser
<!DOCTYPE html>
<html>
<head>
<script src="path/to/protobuf.min.js"></script>
<script>
// Make protobuf root available globally
const root = window.root;
const Container = root.DBMessaging.Protobuf.Container;
const CDPValueType = root.ICD.Protobuf.CDPValueType;
const EventQuery = root.DBMessaging.Protobuf.EventQuery;
</script>
<script src="path/to/generated/containerPb.js"></script>
<script src="path/to/client.js"></script>
</head>
<body>
<script>
const client = new cdplogger.Client('ws://127.0.0.1:17000');
// List logged nodes
client.requestLoggedNodes().then(nodes => {
console.log("Available nodes:", nodes);
});
</script>
</body>
</html>Contact
Email: [email protected]
License
MIT