GUIDE: Crestron Home Logging

GUIDE: Crestron Home Logging

To effectively test the module it is likely you will need to capture logging information from the console. You can connect to the console of your processor using Crestron Toolbox in the same fashion as every other crestron processor.


With the advent of 3.19 there are now two paths you can take to enable logging, and it depends on the state of the driver. The next section describes how to do it with the new CH commands, but if that doesn’t work follow the section section.

Enabling Debug

Once you have a connection you will need to enter some console commands to be able to see the logging information.

The first step is to turn on the program commands by entering

ENABLEPROGRAMCMD

at the prompt. This will allow you to use the debugging commands and see the log lines printed to the console. You only have to do this once (some of the other commands need to be entered
each time).

Once you have done this the details you get will depend on the driver's build. If you have a debug version then you will very likely see quite a lot of log information being produced immediately. If you don’t then you may need to specifically turn on the debug commands.

NOTE: if any of the console commands don’t work then you may need to enter this command again.

Using CH command

The CH command is used for systems that are at 3.18 or higher. If you are using firmware older than that then follow the instructions in the next section.

The logging command looks like this

CP4-R> ch drivers logger <driver_name> <level>

Get a list of drivers

To get a list of available drivers type

CP4-R>ch drivers logger

Drivers Debug
Drivers\Capabilities Debug
Drivers\Catalog Debug
Drivers\Denkovi SmartDen IP-16R Debug
Drivers\PDEG
Drivers\HostManager Debug
Drivers\InterProcessor Debug
Drivers\Uninitialized Debug

This will list the various levels for each of the drivers you have loaded and give you their names.

Enable logging for a specific driver

To change the level of the PDEG (dynalite) driver to debug for example you would type

CP4-R>ch drivers logger PDEG Debug

In many cases this can be abbreviated, so for example to

CP4-R>ch dr l PDEG Debug

You can also turn the logging on for all drivers by entering

CP4-R>ch drivers logger Debug

Turn Off driver logging

You can turn off driver logging, by setting it back to the default Info level with

CP4-R>ch drivers logger Info

Older Drivers using CCDINFO

To enable debugging you will need to work out the driver instance. This is an ID number that is required for the the logging commands. To get the list of drivers on the processor you will need to run

CCDINFO

This will return a list of all of the installed drivers on your system.


This list has entries that look like this

--- Driver Info for Driver ID 28---
Driver: Nice - DMBM
Type: Platform
GUID: 3d11ba47-a54b-499b-8af3-4f33997a2b32
SDK Version: 8.0.0
Version: 1.0.1.0 (07/26/2022 00:00:00)
Using RADCommon, Version=15.0.1.0, Culture=neutral,
PublicKeyToken=null
Using RADCommon, Version=15.0.1.0, Culture=neutral,
PublicKeyToken=null
--- Driver Info End ---

The key is to identify the exact driver you need to use, which is typically done by identifying the driver name in the first line. The actual info we need is the Driver ID, 28 in the example above.

For most drivers this is fairly straightforward as there will only be a single entry for the driver, unless you have loaded multiple versions, in which case they are numbered in the order you
loaded them.

For a Platform driver you will have a single entry for the Platform and then, depending on the driver, many entries for each of the paired devices (the ones that appear in the paired devices
folder). The numbers follow the order they are loaded into the Paired Devices folder, so you may need to keep tabs on that to work out which one you need.

Most of the drivers we produce have the logging in the Platform driver only, so it's likely you can ignore all the paired devices.

Enabling Logging from the Console

To enable logging on a driver you need to know it’s ID. If you haven’t already, read the section above for details on how to get the ID.

To enable logging, you need to enter

CCDLOGGING XX ON

At the console, where the red XX would be replaced by the driver ID. So if the driver ID was 28 then you would need to enter

CCDLOGGING 28 ON

As soon as you enter this you will immediately see logging information in the console. Disabling Logging from the Console To disable logging, you need to enter

CCDLOGGING XX OFF

At the console, where the red XX would be replaced by the driver ID. So if the driver ID was 28 then you would need to enter

CCDLOGGING 28 OFF

Capturing and Sending Logs

Once you have some logging information in the console you may need or want to send it back to us for review. To capture the logs you can either copy and paste the log entries into a text file
or using the Logging, Save Buffer option to save the entire console session.

    • Related Articles

    • GUIDE: Beta Testing Chowmain Crestron Home Drivers

      Overview This document covers the manual installation, testing and removal of Crestron Home beta drivers. If you want to replace the driver from the online database, or if it's not currently there, you can manually install the driver. There are a few ...

    • HOW TO: License Chowmain Crestron Home Drivers

      NOTE: Licensed Chowmain drivers come with a complimentary 90-day trial period. To license the driver, installation of the Chowmain Project Agent is required. The Project Agent is also required for automatic driver updates. Throughout the 90-day trial ...

    • HOW TO: License Chowmain Nice Home Management / ELAN Drivers

      Link Project Code to Nice Home Management Project Ensure Chowmain Agent is installed on primary Nice Home Management Controller. If not, follow the previous information Navigate to the Chowmain Agent Communication Device (it can be found under ...

    • HOW TO: Install Chowmain Nice Home Management / ELAN Agent

      Installation of the Chowmain Agent is required to licence drivers. Chowmain Project Agent is a Generic Communication Device which can be located under Communication Devices in Climate, Lighting and Input/Output. Only a single instance of Chowmain ...

    • GUIDE: Troubleshooting and Diagnostics with Chowmain RTI Drivers

      How to Fetch Logs for RTI To fetch the logs we need to do a little bit of config for the drivers first. Driver Config For each driver you want to log, go to the Driver Properties and look for the Debug Settings section at the bottom. To Enable the ...